Fix #709 by deriving row/ann colors from the channel color
[pulseview.git] / pv / views / trace / trace.hpp
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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP
22
23 #include <QColor>
24 #include <QPainter>
25 #include <QPen>
26 #include <QRect>
27 #include <QString>
28
29 #include <cstdint>
30
31 #include "tracetreeitem.hpp"
32
33 #include "pv/data/signalbase.hpp"
34
35 using std::shared_ptr;
36
37 class QFormLayout;
38
39 namespace pv {
40
41 namespace data {
42 class SignalBase;
43 }
44
45 namespace widgets {
46 class Popup;
47 }
48
49 namespace views {
50 namespace trace {
51
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  */
62 class Trace : public TraceTreeItem
63 {
64         Q_OBJECT
65
66 public:
67         /**
68          * Allowed values for the multi-segment display mode.
69          *
70          * Note: Consider these locations when updating the list:
71          * *
72          * @ref View::set_segment_display_mode
73          * @ref View::on_segment_changed
74          * @ref AnalogSignal::get_analog_segment_to_paint
75          * @ref AnalogSignal::get_logic_segment_to_paint
76          * @ref LogicSignal::get_logic_segment_to_paint
77          * @ref StandardBar
78          */
79         enum SegmentDisplayMode {
80                 ShowLastSegmentOnly = 1,
81                 ShowLastCompleteSegmentOnly,
82                 ShowSingleSegmentOnly,
83                 ShowAllSegments,
84                 ShowAccumulatedIntensity
85         };
86
87 private:
88         static const QPen AxisPen;
89         static const int LabelHitPadding;
90
91         static const QColor BrightGrayBGColor;
92         static const QColor DarkGrayBGColor;
93
94 protected:
95         Trace(shared_ptr<data::SignalBase> channel);
96
97 public:
98         /**
99          * Returns the underlying SignalBase instance.
100          */
101         shared_ptr<data::SignalBase> base() const;
102
103         /**
104          * Configures the segment display mode to use.
105          */
106         virtual void set_segment_display_mode(SegmentDisplayMode mode);
107
108         /**
109          * Paints the signal label.
110          * @param p the QPainter to paint into.
111          * @param rect the rectangle of the header area.
112          * @param hover true if the label is being hovered over by the mouse.
113          */
114         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
115
116         virtual QMenu* create_context_menu(QWidget *parent);
117
118         pv::widgets::Popup* create_popup(QWidget *parent);
119
120         /**
121          * Computes the outline rectangle of a label.
122          * @param rect the rectangle of the header area.
123          * @return Returns the rectangle of the signal label.
124          */
125         QRectF label_rect(const QRectF &rect) const;
126
127         void set_current_segment(const int segment);
128
129         int get_current_segment() const;
130
131 protected:
132         /**
133          * Paints the background layer of the signal with a QPainter.
134          * @param p The QPainter to paint into.
135          * @param pp The painting parameters object to paint with.
136          */
137         virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
138
139         /**
140          * Paints a zero axis across the viewport.
141          * @param p the QPainter to paint into.
142          * @param pp the painting parameters object to paint with.
143          * @param y the y-offset of the axis.
144          */
145         void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
146
147         void add_color_option(QWidget *parent, QFormLayout *form);
148
149         void create_popup_form();
150
151         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
152
153 protected Q_SLOTS:
154         virtual void on_name_changed(const QString &text);
155
156         virtual void on_color_changed(const QColor &color);
157
158         void on_popup_closed();
159
160 private Q_SLOTS:
161         void on_nameedit_changed(const QString &name);
162
163         void on_coloredit_changed(const QColor &color);
164
165 protected:
166         shared_ptr<data::SignalBase> base_;
167         QPen axis_pen_;
168
169         SegmentDisplayMode segment_display_mode_;
170
171         /// The ID of the currently displayed segment
172         int current_segment_;
173
174 private:
175         pv::widgets::Popup *popup_;
176         QFormLayout *popup_form_;
177 };
178
179 } // namespace trace
180 } // namespace views
181 } // namespace pv
182
183 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP