Added pv::widgets::ColourButton
[pulseview.git] / pv / view / cursor.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_CURSOR_H
22 #define PULSEVIEW_PV_VIEW_CURSOR_H
23
24 #include "timemarker.h"
25
26 #include <boost/shared_ptr.hpp>
27
28 #include <QSizeF>
29
30 class QPainter;
31
32 namespace pv {
33 namespace view {
34
35 class Cursor : public TimeMarker
36 {
37         Q_OBJECT
38
39 public:
40         static const QColor LineColour;
41         static const QColor FillColour;
42         static const QColor HighlightColour;
43         static const QColor TextColour;
44
45         static const int Offset;
46
47         static const int ArrowSize;
48
49 public:
50         /**
51          * Constructor.
52          * @param view A reference to the view that owns this cursor pair.
53          * @param time The time to set the flag to.
54          */
55         Cursor(View &view, double time);
56
57 public:
58         /**
59          * Gets the marker label rectangle.
60          * @param rect The rectangle of the ruler client area.
61          * @return Returns the label rectangle.
62          */
63         QRectF get_label_rect(const QRect &rect) const;
64
65         /**
66          * Paints the cursor's label to the ruler.
67          * @param p The painter to draw with.
68          * @param rect The rectangle of the ruler client area.
69          * @param prefix The index of the SI prefix to use.
70          */
71         void paint_label(QPainter &p, const QRect &rect,
72                 unsigned int prefix);
73
74 private:
75         void compute_text_size(QPainter &p, unsigned int prefix);
76
77         boost::shared_ptr<Cursor> get_other_cursor() const;
78
79 private:
80         QSizeF _text_size;
81 };
82
83 } // namespace view
84 } // namespace pv
85
86 #endif // PULSEVIEW_PV_VIEW_CURSOR_H