DecodeTrace: Reset cached trace properties when decoder stack resets
[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 private:
67         static const QPen AxisPen;
68         static const int LabelHitPadding;
69
70         static const QColor BrightGrayBGColour;
71         static const QColor DarkGrayBGColour;
72
73 protected:
74         Trace(shared_ptr<data::SignalBase> channel);
75
76 public:
77         /**
78          * Returns the underlying SignalBase instance.
79          */
80         shared_ptr<data::SignalBase> base() const;
81
82         /**
83          * Sets the name of the signal.
84          */
85         virtual void set_name(QString name);
86
87         /**
88          * Set the colour of the signal.
89          */
90         virtual void set_colour(QColor colour);
91
92         /**
93          * Paints the signal label.
94          * @param p the QPainter to paint into.
95          * @param rect the rectangle of the header area.
96          * @param hover true if the label is being hovered over by the mouse.
97          */
98         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
99
100         virtual QMenu* create_context_menu(QWidget *parent);
101
102         pv::widgets::Popup* create_popup(QWidget *parent);
103
104         /**
105          * Computes the outline rectangle of a label.
106          * @param rect the rectangle of the header area.
107          * @return Returns the rectangle of the signal label.
108          */
109         QRectF label_rect(const QRectF &rect) const;
110
111 protected:
112         /**
113          * Paints the background layer of the signal with a QPainter.
114          * @param p The QPainter to paint into.
115          * @param pp The painting parameters object to paint with.
116          */
117         virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
118
119         /**
120          * Paints a zero axis across the viewport.
121          * @param p the QPainter to paint into.
122          * @param pp the painting parameters object to paint with.
123          * @param y the y-offset of the axis.
124          */
125         void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
126
127         void add_colour_option(QWidget *parent, QFormLayout *form);
128
129         void create_popup_form();
130
131         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
132
133 protected Q_SLOTS:
134         virtual void on_name_changed(const QString &text);
135
136         virtual void on_colour_changed(const QColor &colour);
137
138         void on_popup_closed();
139
140 private Q_SLOTS:
141         void on_nameedit_changed(const QString &name);
142
143         void on_colouredit_changed(const QColor &colour);
144
145 protected:
146         shared_ptr<data::SignalBase> base_;
147         QPen axis_pen_;
148
149 private:
150         pv::widgets::Popup *popup_;
151         QFormLayout *popup_form_;
152 };
153
154 } // namespace trace
155 } // namespace views
156 } // namespace pv
157
158 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP