]>
Commit | Line | Data |
---|---|---|
931f20b0 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 | |
efdec55a | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
931f20b0 JH |
18 | */ |
19 | ||
8845be3c UH |
20 | #ifndef PULSEVIEW_PV_VIEWS_TRACE_TRACE_HPP |
21 | #define PULSEVIEW_PV_VIEWS_TRACE_TRACE_HPP | |
931f20b0 JH |
22 | |
23 | #include <QColor> | |
24 | #include <QPainter> | |
fe08b6e8 | 25 | #include <QPen> |
931f20b0 JH |
26 | #include <QRect> |
27 | #include <QString> | |
28 | ||
cafe470e | 29 | #include <cstdint> |
931f20b0 | 30 | |
af503b10 | 31 | #include "tracetreeitem.hpp" |
931f20b0 | 32 | |
1931b5f9 | 33 | #include <pv/globalsettings.hpp> |
bf0edd2b SA |
34 | #include "pv/data/signalbase.hpp" |
35 | ||
6f925ba9 UH |
36 | using std::shared_ptr; |
37 | ||
b213ef09 JH |
38 | class QFormLayout; |
39 | ||
931f20b0 | 40 | namespace pv { |
931f20b0 | 41 | |
5ed05b69 SA |
42 | namespace data { |
43 | class SignalBase; | |
44 | } | |
45 | ||
23935421 JH |
46 | namespace widgets { |
47 | class Popup; | |
48 | } | |
49 | ||
f4e57597 | 50 | namespace views { |
1573bf16 | 51 | namespace trace { |
01fd3263 | 52 | |
1373fec5 SA |
53 | /** |
54 | * The Trace class represents a @ref TraceTreeItem which occupies some vertical | |
55 | * space on the canvas and spans across its entire width, essentially showing | |
56 | * a time series of values, events, objects or similar. While easily confused | |
57 | * with @ref Signal, the difference is that Trace may represent anything that | |
58 | * can be drawn, not just numeric values. One example is a @ref DecodeTrace. | |
59 | * | |
60 | * For this reason, Trace is more generic and contains properties and helpers | |
61 | * that benefit any kind of time series items. | |
62 | */ | |
1931b5f9 | 63 | class Trace : public TraceTreeItem, public GlobalSettingsInterface |
931f20b0 JH |
64 | { |
65 | Q_OBJECT | |
66 | ||
7daebd05 SA |
67 | public: |
68 | /** | |
69 | * Allowed values for the multi-segment display mode. | |
70 | * | |
558ad6ce SA |
71 | * Note: Consider these locations when updating the list: |
72 | * * | |
73 | * @ref View::set_segment_display_mode | |
89914a86 | 74 | * @ref View::on_segment_changed |
558ad6ce SA |
75 | * @ref AnalogSignal::get_analog_segment_to_paint |
76 | * @ref AnalogSignal::get_logic_segment_to_paint | |
77 | * @ref LogicSignal::get_logic_segment_to_paint | |
89914a86 | 78 | * @ref StandardBar |
7daebd05 SA |
79 | */ |
80 | enum SegmentDisplayMode { | |
81 | ShowLastSegmentOnly = 1, | |
558ad6ce | 82 | ShowLastCompleteSegmentOnly, |
7daebd05 SA |
83 | ShowSingleSegmentOnly, |
84 | ShowAllSegments, | |
85 | ShowAccumulatedIntensity | |
86 | }; | |
87 | ||
931f20b0 | 88 | private: |
fe08b6e8 | 89 | static const QPen AxisPen; |
931f20b0 JH |
90 | static const int LabelHitPadding; |
91 | ||
641574bc SA |
92 | static const QColor BrightGrayBGColor; |
93 | static const QColor DarkGrayBGColor; | |
f6a93932 | 94 | static const QColor ErrorBgColor; |
ac0708fb | 95 | |
931f20b0 | 96 | protected: |
4640a84e | 97 | Trace(shared_ptr<data::SignalBase> signal); |
99c49526 | 98 | ~Trace(); |
931f20b0 JH |
99 | |
100 | public: | |
5ed05b69 SA |
101 | /** |
102 | * Returns the underlying SignalBase instance. | |
103 | */ | |
104 | shared_ptr<data::SignalBase> base() const; | |
105 | ||
cbd9ec7f SA |
106 | /** |
107 | * Returns true if the item may be selected. | |
108 | */ | |
109 | virtual bool is_selectable(QPoint pos) const; | |
110 | ||
111 | /** | |
112 | * Returns true if the item may be dragged/moved. | |
113 | */ | |
119c5c23 | 114 | virtual bool is_draggable(QPoint pos) const; |
cbd9ec7f | 115 | |
7daebd05 SA |
116 | /** |
117 | * Configures the segment display mode to use. | |
118 | */ | |
119 | virtual void set_segment_display_mode(SegmentDisplayMode mode); | |
120 | ||
1931b5f9 SA |
121 | virtual void on_setting_changed(const QString &key, const QVariant &value); |
122 | ||
931f20b0 | 123 | /** |
7db87de3 | 124 | * Paints the signal label. |
931f20b0 | 125 | * @param p the QPainter to paint into. |
b3f44329 | 126 | * @param rect the rectangle of the header area. |
931f20b0 JH |
127 | * @param hover true if the label is being hovered over by the mouse. |
128 | */ | |
b3f44329 | 129 | virtual void paint_label(QPainter &p, const QRect &rect, bool hover); |
931f20b0 | 130 | |
f6a93932 SA |
131 | /** |
132 | * Paints the signal's current error message text. | |
133 | * @param p the QPainter to paint into. | |
134 | * @param pp The painting parameters object to paint with. | |
135 | */ | |
136 | virtual void paint_error(QPainter &p, const ViewItemPaintParams &pp); | |
137 | ||
9e773fec | 138 | virtual QMenu* create_header_context_menu(QWidget *parent); |
9b6378f1 | 139 | |
79b53a1a SA |
140 | virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos); |
141 | ||
569d1e41 JH |
142 | pv::widgets::Popup* create_popup(QWidget *parent); |
143 | ||
d7c0ca4a JH |
144 | /** |
145 | * Computes the outline rectangle of a label. | |
b3f44329 | 146 | * @param rect the rectangle of the header area. |
d7c0ca4a JH |
147 | * @return Returns the rectangle of the signal label. |
148 | */ | |
b3f44329 | 149 | QRectF label_rect(const QRectF &rect) const; |
d7c0ca4a | 150 | |
d9b55cc8 SA |
151 | /** |
152 | * Computes the outline rectangle of the viewport hit-box. | |
f6a93932 | 153 | * @param pp The painting parameters object to paint with. |
d9b55cc8 SA |
154 | * @return Returns the rectangle of the hit-box. |
155 | * @remarks The default implementation returns an empty hit-box. | |
156 | */ | |
157 | virtual QRectF hit_box_rect(const ViewItemPaintParams &pp) const; | |
158 | ||
2749b858 SA |
159 | void set_current_segment(const int segment); |
160 | ||
161 | int get_current_segment() const; | |
162 | ||
1931b5f9 SA |
163 | virtual void hover_point_changed(const QPoint &hp); |
164 | ||
569d1e41 | 165 | protected: |
99af6802 | 166 | /** |
5d738861 UH |
167 | * Paints the background layer of the signal with a QPainter. |
168 | * @param p The QPainter to paint into. | |
169 | * @param pp The painting parameters object to paint with. | |
99af6802 | 170 | */ |
60938e04 | 171 | virtual void paint_back(QPainter &p, ViewItemPaintParams &pp); |
99af6802 | 172 | |
fe08b6e8 JH |
173 | /** |
174 | * Paints a zero axis across the viewport. | |
175 | * @param p the QPainter to paint into. | |
97904bf7 | 176 | * @param pp the painting parameters object to paint with. |
fe08b6e8 | 177 | * @param y the y-offset of the axis. |
fe08b6e8 | 178 | */ |
60938e04 | 179 | void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y); |
fe08b6e8 | 180 | |
1931b5f9 SA |
181 | /** |
182 | * Draw a hover marker under the cursor position. | |
183 | * @param p The painter to draw into. | |
184 | */ | |
185 | void paint_hover_marker(QPainter &p); | |
186 | ||
641574bc | 187 | void add_color_option(QWidget *parent, QFormLayout *form); |
91e8bf08 | 188 | |
37fd11b1 JH |
189 | void create_popup_form(); |
190 | ||
569d1e41 JH |
191 | virtual void populate_popup_form(QWidget *parent, QFormLayout *form); |
192 | ||
bf0edd2b SA |
193 | protected Q_SLOTS: |
194 | virtual void on_name_changed(const QString &text); | |
641574bc | 195 | virtual void on_color_changed(const QColor &color); |
f6a93932 | 196 | virtual void on_error_message_changed(const QString &msg); |
91e8bf08 | 197 | |
20eaae39 JH |
198 | void on_popup_closed(); |
199 | ||
bf0edd2b SA |
200 | private Q_SLOTS: |
201 | void on_nameedit_changed(const QString &name); | |
202 | ||
641574bc | 203 | void on_coloredit_changed(const QColor &color); |
bf0edd2b | 204 | |
79b53a1a SA |
205 | void on_create_marker_here() const; |
206 | ||
931f20b0 | 207 | protected: |
6f925ba9 | 208 | shared_ptr<data::SignalBase> base_; |
561ba3ae | 209 | QPen axis_pen_; |
931f20b0 | 210 | |
7daebd05 | 211 | SegmentDisplayMode segment_display_mode_; |
1931b5f9 | 212 | bool show_hover_marker_; |
7daebd05 | 213 | |
79b53a1a SA |
214 | uint32_t context_menu_x_pos_; |
215 | ||
2749b858 SA |
216 | /// The ID of the currently displayed segment |
217 | int current_segment_; | |
218 | ||
37fd11b1 | 219 | private: |
8dbbc7f0 JH |
220 | pv::widgets::Popup *popup_; |
221 | QFormLayout *popup_form_; | |
931f20b0 JH |
222 | }; |
223 | ||
1573bf16 | 224 | } // namespace trace |
f4e57597 | 225 | } // namespace views |
931f20b0 JH |
226 | } // namespace pv |
227 | ||
8845be3c | 228 | #endif // PULSEVIEW_PV_VIEWS_TRACE_TRACE_HPP |