MinGW: Fix a compile error due to a missing #include.
[pulseview.git] / pv / views / trace / viewwidget.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2013 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_VIEWWIDGET_HPP
21 #define PULSEVIEW_PV_VIEWWIDGET_HPP
22
23 #include <memory>
24
25 #include <QWidget>
26
27 using std::shared_ptr;
28 using std::vector;
29
30 class QTouchEvent;
31
32 namespace pv {
33 namespace views {
34 namespace trace {
35
36 class View;
37 class ViewItem;
38
39 class ViewWidget : public QWidget
40 {
41         Q_OBJECT
42
43 protected:
44         ViewWidget(View &parent);
45
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          * @remarks the default implementation does nothing.
51          */
52         virtual void item_hover(const shared_ptr<ViewItem> &item);
53
54         /**
55          * Indicates the event an a view item has been clicked.
56          * @param item the view item that has been clicked.
57          * @remarks the default implementation does nothing.
58          */
59         virtual void item_clicked(const shared_ptr<ViewItem> &item);
60
61         /**
62          * Returns true if the selection of row items allows dragging.
63          * @return Returns true if the drag is acceptable.
64          */
65         bool accept_drag() const;
66
67         /**
68          * Returns true if the mouse button is down.
69          */
70         bool mouse_down() const;
71
72         /**
73          * Drag the dragging items by the delta offset.
74          * @param delta the drag offset in pixels.
75          */
76         void drag_items(const QPoint &delta);
77
78         /**
79          * Sets this item into the dragged state.
80          */
81         virtual void drag();
82
83         /**
84          * Drag the background by the delta offset.
85          * @param delta the drag offset in pixels.
86          * @remarks The default implementation does nothing.
87          */
88         virtual void drag_by(const QPoint &delta);
89
90         /**
91          * Sets this item into the un-dragged state.
92          */
93         virtual void drag_release();
94
95         /**
96          * Gets the items in the view widget.
97          */
98         virtual vector< shared_ptr<ViewItem> > items() = 0;
99
100         /**
101          * Gets the first view item which has a hit-box that contains @c pt .
102          * @param pt the point to search with.
103          * @return the view item that has been found, or and empty
104          *   @c shared_ptr if no item was found.
105          */
106         virtual shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt) = 0;
107
108         /**
109          * Handles left mouse button press events.
110          * @param event the mouse event that triggered this handler.
111          */
112         void mouse_left_press_event(QMouseEvent *event);
113
114         /**
115          * Handles left mouse button release events.
116          * @param event the mouse event that triggered this handler.
117          */
118         void mouse_left_release_event(QMouseEvent *event);
119
120         /**
121          * Handles touch begin update and end events.
122          * @param e the event that triggered this handler.
123          */
124         virtual bool touch_event(QTouchEvent *event);
125
126 protected:
127         bool event(QEvent *event);
128
129         void mousePressEvent(QMouseEvent *event);
130         void mouseReleaseEvent(QMouseEvent *event);
131         void mouseMoveEvent(QMouseEvent *event);
132
133         void leaveEvent(QEvent *event);
134
135 public Q_SLOTS:
136         void clear_selection();
137
138 Q_SIGNALS:
139         void selection_changed();
140
141 protected:
142         pv::views::trace::View &view_;
143         QPoint mouse_point_;
144         QPoint mouse_down_point_;
145         shared_ptr<ViewItem> mouse_down_item_;
146         bool item_dragging_;
147 };
148
149 } // namespace trace
150 } // namespace views
151 } // namespace pv
152
153 #endif // PULSEVIEW_PV_VIEWWIDGET_HPP