]>
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 | ||
f4e57597 SA |
20 | #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP |
21 | #define PULSEVIEW_PV_VIEWS_TRACEVIEW_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 | |
bf0edd2b SA |
33 | #include "pv/data/signalbase.hpp" |
34 | ||
6f925ba9 UH |
35 | using std::shared_ptr; |
36 | ||
b213ef09 JH |
37 | class QFormLayout; |
38 | ||
931f20b0 | 39 | namespace pv { |
931f20b0 | 40 | |
5ed05b69 SA |
41 | namespace data { |
42 | class SignalBase; | |
43 | } | |
44 | ||
23935421 JH |
45 | namespace widgets { |
46 | class Popup; | |
47 | } | |
48 | ||
f4e57597 | 49 | namespace views { |
1573bf16 | 50 | namespace trace { |
01fd3263 | 51 | |
1373fec5 SA |
52 | /** |
53 | * The Trace class represents a @ref TraceTreeItem which occupies some vertical | |
54 | * space on the canvas and spans across its entire width, essentially showing | |
55 | * a time series of values, events, objects or similar. While easily confused | |
56 | * with @ref Signal, the difference is that Trace may represent anything that | |
57 | * can be drawn, not just numeric values. One example is a @ref DecodeTrace. | |
58 | * | |
59 | * For this reason, Trace is more generic and contains properties and helpers | |
60 | * that benefit any kind of time series items. | |
61 | */ | |
af503b10 | 62 | class Trace : public TraceTreeItem |
931f20b0 JH |
63 | { |
64 | Q_OBJECT | |
65 | ||
7daebd05 SA |
66 | public: |
67 | /** | |
68 | * Allowed values for the multi-segment display mode. | |
69 | * | |
558ad6ce SA |
70 | * Note: Consider these locations when updating the list: |
71 | * * | |
72 | * @ref View::set_segment_display_mode | |
73 | * @ref AnalogSignal::get_analog_segment_to_paint | |
74 | * @ref AnalogSignal::get_logic_segment_to_paint | |
75 | * @ref LogicSignal::get_logic_segment_to_paint | |
7daebd05 SA |
76 | */ |
77 | enum SegmentDisplayMode { | |
78 | ShowLastSegmentOnly = 1, | |
558ad6ce | 79 | ShowLastCompleteSegmentOnly, |
7daebd05 SA |
80 | ShowSingleSegmentOnly, |
81 | ShowAllSegments, | |
82 | ShowAccumulatedIntensity | |
83 | }; | |
84 | ||
931f20b0 | 85 | private: |
fe08b6e8 | 86 | static const QPen AxisPen; |
931f20b0 JH |
87 | static const int LabelHitPadding; |
88 | ||
d55923a6 SA |
89 | static const QColor BrightGrayBGColour; |
90 | static const QColor DarkGrayBGColour; | |
ac0708fb | 91 | |
931f20b0 | 92 | protected: |
6f925ba9 | 93 | Trace(shared_ptr<data::SignalBase> channel); |
931f20b0 JH |
94 | |
95 | public: | |
5ed05b69 SA |
96 | /** |
97 | * Returns the underlying SignalBase instance. | |
98 | */ | |
99 | shared_ptr<data::SignalBase> base() const; | |
100 | ||
931f20b0 JH |
101 | /** |
102 | * Sets the name of the signal. | |
103 | */ | |
104 | virtual void set_name(QString name); | |
105 | ||
931f20b0 JH |
106 | /** |
107 | * Set the colour of the signal. | |
108 | */ | |
bf0edd2b | 109 | virtual void set_colour(QColor colour); |
931f20b0 | 110 | |
7daebd05 SA |
111 | /** |
112 | * Configures the segment display mode to use. | |
113 | */ | |
114 | virtual void set_segment_display_mode(SegmentDisplayMode mode); | |
115 | ||
931f20b0 | 116 | /** |
7db87de3 | 117 | * Paints the signal label. |
931f20b0 | 118 | * @param p the QPainter to paint into. |
b3f44329 | 119 | * @param rect the rectangle of the header area. |
931f20b0 JH |
120 | * @param hover true if the label is being hovered over by the mouse. |
121 | */ | |
b3f44329 | 122 | virtual void paint_label(QPainter &p, const QRect &rect, bool hover); |
931f20b0 | 123 | |
9b6378f1 JH |
124 | virtual QMenu* create_context_menu(QWidget *parent); |
125 | ||
569d1e41 JH |
126 | pv::widgets::Popup* create_popup(QWidget *parent); |
127 | ||
d7c0ca4a JH |
128 | /** |
129 | * Computes the outline rectangle of a label. | |
b3f44329 | 130 | * @param rect the rectangle of the header area. |
d7c0ca4a JH |
131 | * @return Returns the rectangle of the signal label. |
132 | */ | |
b3f44329 | 133 | QRectF label_rect(const QRectF &rect) const; |
d7c0ca4a | 134 | |
2749b858 SA |
135 | void set_current_segment(const int segment); |
136 | ||
137 | int get_current_segment() const; | |
138 | ||
569d1e41 | 139 | protected: |
99af6802 | 140 | /** |
5d738861 UH |
141 | * Paints the background layer of the signal with a QPainter. |
142 | * @param p The QPainter to paint into. | |
143 | * @param pp The painting parameters object to paint with. | |
99af6802 | 144 | */ |
60938e04 | 145 | virtual void paint_back(QPainter &p, ViewItemPaintParams &pp); |
99af6802 | 146 | |
fe08b6e8 JH |
147 | /** |
148 | * Paints a zero axis across the viewport. | |
149 | * @param p the QPainter to paint into. | |
97904bf7 | 150 | * @param pp the painting parameters object to paint with. |
fe08b6e8 | 151 | * @param y the y-offset of the axis. |
fe08b6e8 | 152 | */ |
60938e04 | 153 | void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y); |
fe08b6e8 | 154 | |
91e8bf08 JH |
155 | void add_colour_option(QWidget *parent, QFormLayout *form); |
156 | ||
37fd11b1 JH |
157 | void create_popup_form(); |
158 | ||
569d1e41 JH |
159 | virtual void populate_popup_form(QWidget *parent, QFormLayout *form); |
160 | ||
bf0edd2b SA |
161 | protected Q_SLOTS: |
162 | virtual void on_name_changed(const QString &text); | |
68456dab | 163 | |
bf0edd2b | 164 | virtual void on_colour_changed(const QColor &colour); |
91e8bf08 | 165 | |
20eaae39 JH |
166 | void on_popup_closed(); |
167 | ||
bf0edd2b SA |
168 | private Q_SLOTS: |
169 | void on_nameedit_changed(const QString &name); | |
170 | ||
171 | void on_colouredit_changed(const QColor &colour); | |
172 | ||
931f20b0 | 173 | protected: |
6f925ba9 | 174 | shared_ptr<data::SignalBase> base_; |
561ba3ae | 175 | QPen axis_pen_; |
931f20b0 | 176 | |
7daebd05 SA |
177 | SegmentDisplayMode segment_display_mode_; |
178 | ||
2749b858 SA |
179 | /// The ID of the currently displayed segment |
180 | int current_segment_; | |
181 | ||
37fd11b1 | 182 | private: |
8dbbc7f0 JH |
183 | pv::widgets::Popup *popup_; |
184 | QFormLayout *popup_form_; | |
931f20b0 JH |
185 | }; |
186 | ||
1573bf16 | 187 | } // namespace trace |
f4e57597 | 188 | } // namespace views |
931f20b0 JH |
189 | } // namespace pv |
190 | ||
f4e57597 | 191 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP |