Modified header guards to match file names
[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, 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_HPP
22 #define PULSEVIEW_PV_VIEW_TRACE_HPP
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.hpp"
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          * Computes the outline rectangle of the viewport hit-box.
78          * @param rect the rectangle of the viewport area.
79          * @return Returns the rectangle of the hit-box.
80          */
81         QRectF hit_box_rect(const QRectF &rect) const;
82
83         /**
84          * Paints the signal label.
85          * @param p the QPainter to paint into.
86          * @param rect the rectangle of the header area.
87          * @param hover true if the label is being hovered over by the mouse.
88          */
89         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
90
91         virtual QMenu* create_context_menu(QWidget *parent);
92
93         pv::widgets::Popup* create_popup(QWidget *parent);
94
95         /**
96          * Computes the outline rectangle of a label.
97          * @param rect the rectangle of the header area.
98          * @return Returns the rectangle of the signal label.
99          */
100         QRectF label_rect(const QRectF &rect) const;
101
102 protected:
103         /**
104          * Paints a zero axis across the viewport.
105          * @param p the QPainter to paint into.
106          * @param pp the painting parameters object to paint with.
107          * @param y the y-offset of the axis.
108          */
109         void paint_axis(QPainter &p, const ViewItemPaintParams &pp, int y);
110
111         void add_colour_option(QWidget *parent, QFormLayout *form);
112
113         void create_popup_form();
114
115         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
116
117 private Q_SLOTS:
118         void on_text_changed(const QString &text);
119
120         void on_colour_changed(const QColor &colour);
121
122         void on_popup_closed();
123
124 protected:
125         QString name_;
126         QColor colour_;
127
128 private:
129         pv::widgets::Popup *popup_;
130         QFormLayout *popup_form_;
131 };
132
133 } // namespace view
134 } // namespace pv
135
136 #endif // PULSEVIEW_PV_VIEW_TRACE_HPP