]>
Commit | Line | Data |
---|---|---|
e0e90d80 JH |
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, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
7a01bd36 JH |
21 | #ifndef PULSEVIEW_PV_VIEWITEM_HPP |
22 | #define PULSEVIEW_PV_VIEWITEM_HPP | |
e0e90d80 JH |
23 | |
24 | #include <list> | |
25 | ||
d09674d4 | 26 | #include <QPen> |
2a2512b2 | 27 | |
d4e39570 JH |
28 | #include "viewitempaintparams.hpp" |
29 | ||
e0e90d80 | 30 | class QAction; |
9b6378f1 JH |
31 | class QMenu; |
32 | class QWidget; | |
e0e90d80 JH |
33 | |
34 | namespace pv { | |
a28a212c JH |
35 | |
36 | namespace widgets { | |
37 | class Popup; | |
38 | } | |
39 | ||
e0e90d80 JH |
40 | namespace view { |
41 | ||
c373f828 JH |
42 | class ViewItemOwner; |
43 | ||
26e3af6b | 44 | class ViewItem : public QObject |
e0e90d80 | 45 | { |
2a2512b2 JH |
46 | Q_OBJECT |
47 | ||
819e2e95 | 48 | public: |
ec39632d | 49 | static const QSizeF LabelPadding; |
d09674d4 JH |
50 | static const int HighlightRadius; |
51 | ||
f1283456 | 52 | public: |
26e3af6b | 53 | ViewItem(); |
f1283456 JH |
54 | |
55 | public: | |
096fb584 JH |
56 | /** |
57 | * Returns true if the item is visible and enabled. | |
58 | */ | |
59 | virtual bool enabled() const = 0; | |
60 | ||
f1283456 | 61 | /** |
7ccd5a64 | 62 | * Returns true if the item has been selected by the user. |
f1283456 JH |
63 | */ |
64 | bool selected() const; | |
65 | ||
66 | /** | |
67 | * Selects or deselects the signal. | |
68 | */ | |
69 | void select(bool select = true); | |
70 | ||
0dda6fe5 JH |
71 | /** |
72 | * Returns true if the item is being dragged. | |
73 | */ | |
74 | bool dragging() const; | |
75 | ||
0dda6fe5 JH |
76 | /** |
77 | * Sets this item into the dragged state. | |
78 | */ | |
79 | void drag(); | |
80 | ||
81 | /** | |
82 | * Sets this item into the un-dragged state. | |
83 | */ | |
84 | void drag_release(); | |
85 | ||
23e75650 JH |
86 | /** |
87 | * Drags the item to a delta relative to the drag point. | |
88 | * @param delta the offset from the drag point. | |
89 | */ | |
90 | virtual void drag_by(const QPoint &delta) = 0; | |
91 | ||
0dda6fe5 JH |
92 | /** |
93 | * Get the drag point. | |
be717066 | 94 | * @param rect the rectangle of the widget area. |
0dda6fe5 | 95 | */ |
be717066 | 96 | virtual QPoint point(const QRect &rect) const = 0; |
0dda6fe5 | 97 | |
4a5c385e JH |
98 | /** |
99 | * Computes the outline rectangle of a label. | |
100 | * @param rect the rectangle of the header area. | |
101 | * @return Returns the rectangle of the signal label. | |
102 | */ | |
103 | virtual QRectF label_rect(const QRectF &rect) const = 0; | |
104 | ||
7708eb92 JH |
105 | /** |
106 | * Computes the outline rectangle of the viewport hit-box. | |
107 | * @param rect the rectangle of the viewport area. | |
108 | * @return Returns the rectangle of the hit-box. | |
109 | * @remarks The default implementation returns an empty hit-box. | |
110 | */ | |
111 | virtual QRectF hit_box_rect(const QRectF &rect) const; | |
112 | ||
49028d6c JH |
113 | /** |
114 | * Paints the signal label. | |
115 | * @param p the QPainter to paint into. | |
116 | * @param rect the rectangle of the header area. | |
117 | * @param hover true if the label is being hovered over by the mouse. | |
118 | */ | |
119 | virtual void paint_label(QPainter &p, const QRect &rect, bool hover) = 0; | |
120 | ||
d4e39570 JH |
121 | /** |
122 | * Paints the background layer of the item with a QPainter | |
123 | * @param p the QPainter to paint into. | |
124 | * @param pp the painting parameters object to paint with. | |
125 | **/ | |
126 | virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp); | |
127 | ||
128 | /** | |
129 | * Paints the mid-layer of the item with a QPainter | |
130 | * @param p the QPainter to paint into. | |
131 | * @param pp the painting parameters object to paint with. | |
132 | **/ | |
133 | virtual void paint_mid(QPainter &p, const ViewItemPaintParams &pp); | |
134 | ||
135 | /** | |
136 | * Paints the foreground layer of the item with a QPainter | |
137 | * @param p the QPainter to paint into. | |
138 | * @param pp the painting parameters object to paint with. | |
139 | **/ | |
140 | virtual void paint_fore(QPainter &p, const ViewItemPaintParams &pp); | |
141 | ||
d8d724cc JH |
142 | public: |
143 | /** | |
144 | * Gets the text colour. | |
145 | * @remarks This colour is computed by comparing the lightness | |
146 | * of the trace colour against a threshold to determine whether | |
147 | * white or black would be more visible. | |
148 | */ | |
149 | static QColor select_text_colour(QColor background); | |
150 | ||
a55c544b | 151 | public: |
9b6378f1 JH |
152 | virtual QMenu* create_context_menu(QWidget *parent); |
153 | ||
0f2f14a4 | 154 | virtual pv::widgets::Popup* create_popup(QWidget *parent); |
a28a212c | 155 | |
5ed1adf5 JH |
156 | virtual void delete_pressed(); |
157 | ||
d09674d4 JH |
158 | protected: |
159 | static QPen highlight_pen(); | |
160 | ||
9b6378f1 | 161 | protected: |
8dbbc7f0 | 162 | QWidget *context_parent_; |
23e75650 | 163 | QPoint drag_point_; |
9b6378f1 | 164 | |
f1283456 | 165 | private: |
8dbbc7f0 | 166 | bool selected_; |
e0e90d80 JH |
167 | }; |
168 | ||
169 | } // namespace view | |
170 | } // namespace pv | |
171 | ||
7a01bd36 | 172 | #endif // PULSEVIEW_PV_VIEWITEM_HPP |