Reordered argument handling
[pulseview.git] / pv / view / viewport.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef PULSEVIEW_PV_VIEW_VIEWPORT_HPP
22 #define PULSEVIEW_PV_VIEW_VIEWPORT_HPP
23
24 #include <QTimer>
25 #include <QTouchEvent>
26
27 #include "viewwidget.hpp"
28
29 class QPainter;
30 class QPaintEvent;
31 class Session;
32
33 namespace pv {
34 namespace view {
35
36 class View;
37
38 class Viewport : public ViewWidget
39 {
40         Q_OBJECT
41
42 public:
43         explicit Viewport(View &parent);
44
45 private:
46         /**
47          * Indicates when a view item is being hovered over.
48          * @param item The item that is being hovered over, or @c nullptr
49          * if no view item is being hovered over.
50          */
51         void item_hover(const std::shared_ptr<pv::view::ViewItem> &item);
52
53         /**
54          * Gets the first view item which has a hit-box that contains @c pt .
55          * @param pt the point to search with.
56          * @return the view item that has been found, or and empty
57          *   @c shared_ptr if no item was found.
58          */
59         std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
60                 const QPoint &pt);
61
62         /**
63          * Sets this item into the dragged state.
64          */
65         void drag();
66
67         /**
68          * Drag the background by the delta offset.
69          * @param delta the drag offset in pixels.
70          */
71         void drag_by(const QPoint &delta);
72
73         /**
74          * Sets this item into the un-dragged state.
75          */
76         void drag_release();
77
78         /**
79          * Gets the items in the view widget.
80          */
81         std::vector< std::shared_ptr<pv::view::ViewItem> > items();
82
83         /**
84          * Handles touch begin update and end events.
85          * @param e the event that triggered this handler.
86          */
87         bool touch_event(QTouchEvent *e);
88
89 private:
90         void paintEvent(QPaintEvent *event);
91
92         void mouseDoubleClickEvent(QMouseEvent * event);
93         void wheelEvent(QWheelEvent *event);
94
95 private:
96         double drag_offset_;
97
98         double pinch_offset0_;
99         double pinch_offset1_;
100         bool pinch_zoom_active_;
101 };
102
103 } // namespace view
104 } // namespace pv
105
106 #endif // PULSEVIEW_PV_VIEW_VIEWPORT_HPP