Introduce time units
[pulseview.git] / pv / view / timemarker.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 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_MARKER_HPP
22 #define PULSEVIEW_PV_VIEW_MARKER_HPP
23
24 #include <QColor>
25 #include <QDoubleSpinBox>
26 #include <QObject>
27 #include <QRectF>
28 #include <QWidgetAction>
29
30 #include "timeitem.hpp"
31
32 class QPainter;
33 class QRect;
34
35 namespace pv {
36 namespace view {
37
38 class View;
39
40 class TimeMarker : public TimeItem
41 {
42         Q_OBJECT
43
44 public:
45         static const int ArrowSize;
46
47 protected:
48         /**
49          * Constructor.
50          * @param view A reference to the view that owns this marker.
51          * @param colour A reference to the colour of this cursor.
52          * @param time The time to set the flag to.
53          */
54         TimeMarker(View &view, const QColor &colour, double time);
55
56 public:
57         /**
58          * Gets the time of the marker.
59          */
60         double time() const;
61
62         /**
63          * Sets the time of the marker.
64          */
65         void set_time(double time);
66
67         float get_x() const;
68
69         /**
70          * Gets the arrow-tip point of the time marker.
71          * @param rect the rectangle of the ruler area.
72          */
73         QPoint point(const QRect &rect) const;
74
75         /**
76          * Computes the outline rectangle of a label.
77          * @param rect the rectangle of the header area.
78          * @return Returns the rectangle of the signal label.
79          */
80         QRectF label_rect(const QRectF &rect) const;
81
82         /**
83          * Computes the outline rectangle of the viewport hit-box.
84          * @param rect the rectangle of the viewport area.
85          * @return Returns the rectangle of the hit-box.
86          */
87         QRectF hit_box_rect(const QRectF &rect) const;
88
89         /**
90          * Gets the text to show in the marker.
91          */
92         virtual QString get_text() const = 0;
93
94         /**
95          * Paints the marker's label to the ruler.
96          * @param p The painter to draw with.
97          * @param rect The rectangle of the ruler client area.
98          * @param hover true if the label is being hovered over by the mouse.
99          */
100         void paint_label(QPainter &p, const QRect &rect, bool hover);
101
102         /**
103          * Paints the foreground layer of the item with a QPainter
104          * @param p the QPainter to paint into.
105          * @param pp the painting parameters object to paint with.
106          **/
107         void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
108
109         virtual pv::widgets::Popup* create_popup(QWidget *parent);
110
111 private Q_SLOTS:
112         void on_value_changed(double value);
113
114 protected:
115         const QColor &colour_;
116
117         double time_;
118
119         QSizeF text_size_;
120
121         QWidgetAction *value_action_;
122         QDoubleSpinBox *value_widget_;
123         bool updating_value_widget_;
124 };
125
126 } // namespace view
127 } // namespace pv
128
129 #endif // PULSEVIEW_PV_VIEW_MARKER_HPP