Added context widgets to TimeMarker
[pulseview.git] / pv / view / timemarker.h
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_H
22 #define PULSEVIEW_PV_VIEW_MARKER_H
23
24 #include <QColor>
25 #include <QDoubleSpinBox>
26 #include <QObject>
27 #include <QRectF>
28 #include <QWidgetAction>
29
30 #include "selectableitem.h"
31
32 class QPainter;
33 class QRect;
34
35 namespace pv {
36 namespace view {
37
38 class View;
39
40 class TimeMarker : public SelectableItem
41 {
42         Q_OBJECT
43
44 protected:
45         /**
46          * Constructor.
47          * @param view A reference to the view that owns this marker.
48          * @param colour A reference to the colour of this cursor.
49          * @param time The time to set the flag to.
50          */
51         TimeMarker(View &view, const QColor &colour, double time);
52
53 public:
54         /**
55          * Gets the time of the marker.
56          */
57         double time() const;
58
59         /**
60          * Sets the time of the marker.
61          */
62         void set_time(double time);
63
64         /**
65          * Paints the marker to the viewport.
66          * @param p The painter to draw with.
67          * @param rect The rectangle of the viewport client area.
68          */
69         virtual void paint(QPainter &p, const QRect &rect);
70
71         /**
72          * Gets the marker label rectangle.
73          * @param rect The rectangle of the ruler client area.
74          * @return Returns the label rectangle.
75          */
76         virtual QRectF get_label_rect(const QRect &rect) const = 0;
77
78         /**
79          * Paints the marker's label to the ruler.
80          * @param p The painter to draw with.
81          * @param rect The rectangle of the ruler client area.
82          * @param prefix The SI prefix to paint time value with.
83          */
84         virtual void paint_label(QPainter &p, const QRect &rect,
85                 unsigned int prefix) = 0;
86
87         /**
88          * Returns a list of context menu items to show in the context
89          * bar.
90          */
91         const std::list<QAction*> get_context_bar_actions();
92
93 private slots:
94         void on_value_changed(double value);
95
96 signals:
97         void time_changed();
98
99 protected:
100         View &_view;
101         const QColor &_colour;
102
103         double _time;
104
105         QSizeF _text_size;
106
107         QWidgetAction _value_action;
108         QDoubleSpinBox _value_widget;
109         bool _updating_value_widget;
110 };
111
112 } // namespace view
113 } // namespace pv
114
115 #endif // PULSEVIEW_PV_VIEW_MARKER_H