]>
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 | |
89914a86 | 73 | * @ref View::on_segment_changed |
558ad6ce SA |
74 | * @ref AnalogSignal::get_analog_segment_to_paint |
75 | * @ref AnalogSignal::get_logic_segment_to_paint | |
76 | * @ref LogicSignal::get_logic_segment_to_paint | |
89914a86 | 77 | * @ref StandardBar |
7daebd05 SA |
78 | */ |
79 | enum SegmentDisplayMode { | |
80 | ShowLastSegmentOnly = 1, | |
558ad6ce | 81 | ShowLastCompleteSegmentOnly, |
7daebd05 SA |
82 | ShowSingleSegmentOnly, |
83 | ShowAllSegments, | |
84 | ShowAccumulatedIntensity | |
85 | }; | |
86 | ||
931f20b0 | 87 | private: |
fe08b6e8 | 88 | static const QPen AxisPen; |
931f20b0 JH |
89 | static const int LabelHitPadding; |
90 | ||
d55923a6 SA |
91 | static const QColor BrightGrayBGColour; |
92 | static const QColor DarkGrayBGColour; | |
ac0708fb | 93 | |
931f20b0 | 94 | protected: |
6f925ba9 | 95 | Trace(shared_ptr<data::SignalBase> channel); |
931f20b0 JH |
96 | |
97 | public: | |
5ed05b69 SA |
98 | /** |
99 | * Returns the underlying SignalBase instance. | |
100 | */ | |
101 | shared_ptr<data::SignalBase> base() const; | |
102 | ||
931f20b0 JH |
103 | /** |
104 | * Sets the name of the signal. | |
105 | */ | |
106 | virtual void set_name(QString name); | |
107 | ||
931f20b0 JH |
108 | /** |
109 | * Set the colour of the signal. | |
110 | */ | |
bf0edd2b | 111 | virtual void set_colour(QColor colour); |
931f20b0 | 112 | |
7daebd05 SA |
113 | /** |
114 | * Configures the segment display mode to use. | |
115 | */ | |
116 | virtual void set_segment_display_mode(SegmentDisplayMode mode); | |
117 | ||
931f20b0 | 118 | /** |
7db87de3 | 119 | * Paints the signal label. |
931f20b0 | 120 | * @param p the QPainter to paint into. |
b3f44329 | 121 | * @param rect the rectangle of the header area. |
931f20b0 JH |
122 | * @param hover true if the label is being hovered over by the mouse. |
123 | */ | |
b3f44329 | 124 | virtual void paint_label(QPainter &p, const QRect &rect, bool hover); |
931f20b0 | 125 | |
9b6378f1 JH |
126 | virtual QMenu* create_context_menu(QWidget *parent); |
127 | ||
569d1e41 JH |
128 | pv::widgets::Popup* create_popup(QWidget *parent); |
129 | ||
d7c0ca4a JH |
130 | /** |
131 | * Computes the outline rectangle of a label. | |
b3f44329 | 132 | * @param rect the rectangle of the header area. |
d7c0ca4a JH |
133 | * @return Returns the rectangle of the signal label. |
134 | */ | |
b3f44329 | 135 | QRectF label_rect(const QRectF &rect) const; |
d7c0ca4a | 136 | |
2749b858 SA |
137 | void set_current_segment(const int segment); |
138 | ||
139 | int get_current_segment() const; | |
140 | ||
569d1e41 | 141 | protected: |
99af6802 | 142 | /** |
5d738861 UH |
143 | * Paints the background layer of the signal with a QPainter. |
144 | * @param p The QPainter to paint into. | |
145 | * @param pp The painting parameters object to paint with. | |
99af6802 | 146 | */ |
60938e04 | 147 | virtual void paint_back(QPainter &p, ViewItemPaintParams &pp); |
99af6802 | 148 | |
fe08b6e8 JH |
149 | /** |
150 | * Paints a zero axis across the viewport. | |
151 | * @param p the QPainter to paint into. | |
97904bf7 | 152 | * @param pp the painting parameters object to paint with. |
fe08b6e8 | 153 | * @param y the y-offset of the axis. |
fe08b6e8 | 154 | */ |
60938e04 | 155 | void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y); |
fe08b6e8 | 156 | |
91e8bf08 JH |
157 | void add_colour_option(QWidget *parent, QFormLayout *form); |
158 | ||
37fd11b1 JH |
159 | void create_popup_form(); |
160 | ||
569d1e41 JH |
161 | virtual void populate_popup_form(QWidget *parent, QFormLayout *form); |
162 | ||
bf0edd2b SA |
163 | protected Q_SLOTS: |
164 | virtual void on_name_changed(const QString &text); | |
68456dab | 165 | |
bf0edd2b | 166 | virtual void on_colour_changed(const QColor &colour); |
91e8bf08 | 167 | |
20eaae39 JH |
168 | void on_popup_closed(); |
169 | ||
bf0edd2b SA |
170 | private Q_SLOTS: |
171 | void on_nameedit_changed(const QString &name); | |
172 | ||
173 | void on_colouredit_changed(const QColor &colour); | |
174 | ||
931f20b0 | 175 | protected: |
6f925ba9 | 176 | shared_ptr<data::SignalBase> base_; |
561ba3ae | 177 | QPen axis_pen_; |
931f20b0 | 178 | |
7daebd05 SA |
179 | SegmentDisplayMode segment_display_mode_; |
180 | ||
2749b858 SA |
181 | /// The ID of the currently displayed segment |
182 | int current_segment_; | |
183 | ||
37fd11b1 | 184 | private: |
8dbbc7f0 JH |
185 | pv::widgets::Popup *popup_; |
186 | QFormLayout *popup_form_; | |
931f20b0 JH |
187 | }; |
188 | ||
1573bf16 | 189 | } // namespace trace |
f4e57597 | 190 | } // namespace views |
931f20b0 JH |
191 | } // namespace pv |
192 | ||
f4e57597 | 193 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP |