View: Keep a list of owned traces in RowItemOwner
[pulseview.git] / pv / view / trace.h
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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef PULSEVIEW_PV_VIEW_TRACE_H
22 #define PULSEVIEW_PV_VIEW_TRACE_H
23
24 #include <QColor>
25 #include <QPainter>
26 #include <QPen>
27 #include <QRect>
28 #include <QString>
29
30 #include <stdint.h>
31
32 #include "rowitem.h"
33
34 class QFormLayout;
35
36 namespace pv {
37
38 namespace widgets {
39 class Popup;
40 }
41
42 namespace view {
43
44 class Trace : public RowItem
45 {
46         Q_OBJECT
47
48 private:
49         static const QPen AxisPen;
50         static const int LabelHitPadding;
51
52 protected:
53         Trace(QString name);
54
55 public:
56         /**
57          * Gets the name of this signal.
58          */
59         QString name() const;
60
61         /**
62          * Sets the name of the signal.
63          */
64         virtual void set_name(QString name);
65
66         /**
67          * Get the colour of the signal.
68          */
69         QColor colour() const;
70
71         /**
72          * Set the colour of the signal.
73          */
74         void set_colour(QColor colour);
75
76         /**
77          * Paints the signal label.
78          * @param p the QPainter to paint into.
79          * @param right the x-coordinate of the right edge of the header
80          *      area.
81          * @param hover true if the label is being hovered over by the mouse.
82          */
83         virtual void paint_label(QPainter &p, int right, bool hover);
84
85         virtual QMenu* create_context_menu(QWidget *parent);
86
87         pv::widgets::Popup* create_popup(QWidget *parent);
88
89         /**
90          * Computes the outline rectangle of a label.
91          * @param right the x-coordinate of the right edge of the header
92          *      area.
93          * @return Returns the rectangle of the signal label.
94          */
95         QRectF label_rect(int right);
96
97 protected:
98
99         /**
100          * Gets the text colour.
101          * @remarks This colour is computed by comparing the lightness
102          * of the trace colour against a threshold to determine whether
103          * white or black would be more visible.
104          */
105         QColor get_text_colour() const;
106
107         /**
108          * Paints a zero axis across the viewport.
109          * @param p the QPainter to paint into.
110          * @param y the y-offset of the axis.
111          * @param left the x-coordinate of the left edge of the view.
112          * @param right the x-coordinate of the right edge of the view.
113          */
114         void paint_axis(QPainter &p, int y, int left, int right);
115
116         void add_colour_option(QWidget *parent, QFormLayout *form);
117
118         void create_popup_form();
119
120         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
121
122 private Q_SLOTS:
123         void on_text_changed(const QString &text);
124
125         void on_colour_changed(const QColor &colour);
126
127         void on_popup_closed();
128
129 Q_SIGNALS:
130         void visibility_changed();
131         void text_changed();    
132         void colour_changed();
133
134 protected:
135         QString _name;
136         QColor _colour;
137
138 private:
139         pv::widgets::Popup *_popup;
140         QFormLayout *_popup_form;
141 };
142
143 } // namespace view
144 } // namespace pv
145
146 #endif // PULSEVIEW_PV_VIEW_TRACE_H