Add a tooltip for the "Stack decoder" button/dropdown.
[pulseview.git] / pv / view / 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 widgets {
42 class Popup;
43 }
44
45 namespace views {
46 namespace TraceView {
47
48 class Trace : public TraceTreeItem
49 {
50         Q_OBJECT
51
52 private:
53         static const QPen AxisPen;
54         static const int LabelHitPadding;
55
56         static const QColor BrightGrayBGColour;
57         static const QColor DarkGrayBGColour;
58
59 protected:
60         Trace(shared_ptr<data::SignalBase> channel);
61
62 public:
63         /**
64          * Sets the name of the signal.
65          */
66         virtual void set_name(QString name);
67
68         /**
69          * Set the colour of the signal.
70          */
71         virtual void set_colour(QColor colour);
72
73         /**
74          * Enables or disables the coloured background for this trace.
75          */
76         void set_coloured_bg(bool state);
77
78         /**
79          * Paints the signal label.
80          * @param p the QPainter to paint into.
81          * @param rect the rectangle of the header area.
82          * @param hover true if the label is being hovered over by the mouse.
83          */
84         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
85
86         virtual QMenu* create_context_menu(QWidget *parent);
87
88         pv::widgets::Popup* create_popup(QWidget *parent);
89
90         /**
91          * Computes the outline rectangle of a label.
92          * @param rect the rectangle of the header area.
93          * @return Returns the rectangle of the signal label.
94          */
95         QRectF label_rect(const QRectF &rect) const;
96
97 protected:
98         /**
99          * Paints the background layer of the signal with a QPainter.
100          * @param p The QPainter to paint into.
101          * @param pp The painting parameters object to paint with.
102          */
103         virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp);
104
105         /**
106          * Paints a zero axis across the viewport.
107          * @param p the QPainter to paint into.
108          * @param pp the painting parameters object to paint with.
109          * @param y the y-offset of the axis.
110          */
111         void paint_axis(QPainter &p, const ViewItemPaintParams &pp, int y);
112
113         void add_colour_option(QWidget *parent, QFormLayout *form);
114
115         void create_popup_form();
116
117         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
118
119 protected Q_SLOTS:
120         virtual void on_name_changed(const QString &text);
121
122         virtual void on_colour_changed(const QColor &colour);
123
124         void on_popup_closed();
125
126 private Q_SLOTS:
127         void on_nameedit_changed(const QString &name);
128
129         void on_colouredit_changed(const QColor &colour);
130
131 protected:
132         shared_ptr<data::SignalBase> base_;
133         bool coloured_bg_, coloured_bg_state_;
134
135 private:
136         pv::widgets::Popup *popup_;
137         QFormLayout *popup_form_;
138 };
139
140 } // namespace TraceView
141 } // namespace views
142 } // namespace pv
143
144 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP