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