2 * This file is part of the PulseView project.
4 * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_VIEWWIDGET_HPP
21 #define PULSEVIEW_PV_VIEWWIDGET_HPP
27 using std::shared_ptr;
39 class ViewWidget : public QWidget
44 ViewWidget(View &parent);
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.
52 virtual void item_hover(const shared_ptr<ViewItem> &item);
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.
59 virtual void item_clicked(const shared_ptr<ViewItem> &item);
62 * Returns true if the selection of row items allows dragging.
63 * @return Returns true if the drag is acceptable.
65 bool accept_drag() const;
68 * Returns true if the mouse button is down.
70 bool mouse_down() const;
73 * Drag the dragging items by the delta offset.
74 * @param delta the drag offset in pixels.
76 void drag_items(const QPoint &delta);
79 * Sets this item into the dragged state.
84 * Drag the background by the delta offset.
85 * @param delta the drag offset in pixels.
86 * @remarks The default implementation does nothing.
88 virtual void drag_by(const QPoint &delta);
91 * Sets this item into the un-dragged state.
93 virtual void drag_release();
96 * Gets the items in the view widget.
98 virtual vector< shared_ptr<ViewItem> > items() = 0;
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.
106 virtual shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt) = 0;
109 * Handles left mouse button press events.
110 * @param event the mouse event that triggered this handler.
112 void mouse_left_press_event(QMouseEvent *event);
115 * Handles left mouse button release events.
116 * @param event the mouse event that triggered this handler.
118 void mouse_left_release_event(QMouseEvent *event);
121 * Handles touch begin update and end events.
122 * @param e the event that triggered this handler.
124 virtual bool touch_event(QTouchEvent *event);
127 bool event(QEvent *event);
129 void mousePressEvent(QMouseEvent *event);
130 void mouseReleaseEvent(QMouseEvent *event);
131 void mouseMoveEvent(QMouseEvent *event);
133 void leaveEvent(QEvent *event);
136 void clear_selection();
139 void selection_changed();
142 pv::views::trace::View &view_;
144 QPoint mouse_down_point_;
145 shared_ptr<ViewItem> mouse_down_item_;
153 #endif // PULSEVIEW_PV_VIEWWIDGET_HPP