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