Rework new segment notification mechanism
[pulseview.git] / pv / views / trace / cursor.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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_CURSOR_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_CURSOR_HPP
22
23 #include "timemarker.hpp"
24
25 #include <memory>
26
27 #include <QSizeF>
28
29 using std::shared_ptr;
30
31 class QPainter;
32
33 namespace pv {
34 namespace views {
35 namespace trace {
36
37 class Cursor : public TimeMarker
38 {
39         Q_OBJECT
40
41 public:
42         static const QColor FillColour;
43
44 public:
45         /**
46          * Constructor.
47          * @param view A reference to the view that owns this cursor pair.
48          * @param time The time to set the flag to.
49          */
50         Cursor(View &view, double time);
51
52 public:
53         /**
54          * Returns true if the item is visible and enabled.
55          */
56         bool enabled() const;
57
58         /**
59          * Gets the text to show in the marker.
60          */
61         QString get_text() const;
62
63         /**
64          * Gets the marker label rectangle.
65          * @param rect The rectangle of the ruler client area.
66          * @return Returns the label rectangle.
67          */
68         QRectF label_rect(const QRectF &rect) const;
69
70 private:
71         shared_ptr<Cursor> get_other_cursor() const;
72 };
73
74 } // namespace trace
75 } // namespace views
76 } // namespace pv
77
78 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_CURSOR_HPP