TraceView: Fix variable name
[pulseview.git] / pv / view / 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 class QTouchEvent;
28
29 namespace pv {
30 namespace views {
31 namespace TraceView {
32
33 class View;
34 class ViewItem;
35
36 class ViewWidget : public QWidget
37 {
38         Q_OBJECT
39
40 protected:
41         ViewWidget(View &parent);
42
43         /**
44          * Indicates when a view item is being hovered over.
45          * @param item The item that is being hovered over, or @c nullptr
46          * if no view item is being hovered over.
47          * @remarks the default implementation does nothing.
48          */
49         virtual void item_hover(
50                 const std::shared_ptr<ViewItem> &item);
51
52         /**
53          * Indicates the event an a view item has been clicked.
54          * @param item the view item that has been clicked.
55          * @remarks the default implementation does nothing.
56          */
57         virtual void item_clicked(
58                 const std::shared_ptr<ViewItem> &item);
59
60         /**
61          * Returns true if the selection of row items allows dragging.
62          * @return Returns true if the drag is acceptable.
63          */
64         bool accept_drag() const;
65
66         /**
67          * Returns true if the mouse button is down.
68          */
69         bool mouse_down() const;
70
71         /**
72          * Drag the dragging items by the delta offset.
73          * @param delta the drag offset in pixels.
74          */
75         void drag_items(const QPoint &delta);
76
77         /**
78          * Sets this item into the dragged state.
79          */
80         virtual void drag();
81
82         /**
83          * Drag the background by the delta offset.
84          * @param delta the drag offset in pixels.
85          * @remarks The default implementation does nothing.
86          */
87         virtual void drag_by(const QPoint &delta);
88
89         /**
90          * Sets this item into the un-dragged state.
91          */
92         virtual void drag_release();
93
94         /**
95          * Gets the items in the view widget.
96          */
97         virtual std::vector< std::shared_ptr<ViewItem> > items() = 0;
98
99         /**
100          * Gets the first view item which has a hit-box that contains @c pt .
101          * @param pt the point to search with.
102          * @return the view item that has been found, or and empty
103          *   @c shared_ptr if no item was found.
104          */
105         virtual std::shared_ptr<ViewItem> get_mouse_over_item(
106                 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::TraceView::View &view_;
143         QPoint mouse_point_;
144         QPoint mouse_down_point_;
145         std::shared_ptr<ViewItem> mouse_down_item_;
146         bool item_dragging_;
147 };
148
149 } // namespace TraceView
150 } // namespace views
151 } // namespace pv
152
153 #endif // PULSEVIEW_PV_VIEWWIDGET_HPP