Typo fix: treshold -> threshold
[pulseview.git] / pv / views / trace / cursorpair.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2013 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_CURSORPAIR_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_CURSORPAIR_HPP
22
23 #include "cursor.hpp"
24
25 #include <memory>
26
27 #include <QPainter>
28
29 using std::pair;
30 using std::shared_ptr;
31
32 class QPainter;
33
34 namespace pv {
35 namespace views {
36 namespace trace {
37
38 class CursorPair : public TimeItem
39 {
40 private:
41         static const int DeltaPadding;
42         static const QColor ViewportFillColour;
43
44 public:
45         /**
46          * Constructor.
47          * @param view A reference to the view that owns this cursor pair.
48          */
49         CursorPair(View &view);
50
51 public:
52         /**
53          * Returns true if the item is visible and enabled.
54          */
55         bool enabled() const override;
56
57         /**
58          * Returns a pointer to the first cursor.
59          */
60         shared_ptr<Cursor> first() const;
61
62         /**
63          * Returns a pointer to the second cursor.
64          */
65         shared_ptr<Cursor> second() const;
66
67         /**
68          * Sets the time of the marker.
69          */
70         void set_time(const pv::util::Timestamp& time) override;
71
72         float get_x() const override;
73
74         QPoint drag_point(const QRect &rect) const override;
75
76         pv::widgets::Popup* create_popup(QWidget *parent) override;
77
78 public:
79         QRectF label_rect(const QRectF &rect) const override;
80
81         /**
82          * Paints the marker's label to the ruler.
83          * @param p The painter to draw with.
84          * @param rect The rectangle of the ruler client area.
85          * @param hover true if the label is being hovered over by the mouse.
86          */
87         void paint_label(QPainter &p, const QRect &rect, bool hover) override;
88
89         /**
90          * Paints the background layer of the item with a QPainter
91          * @param p the QPainter to paint into.
92          * @param pp the painting parameters object to paint with.
93          */
94         void paint_back(QPainter &p, ViewItemPaintParams &pp) override;
95
96         /**
97          * Constructs the string to display.
98          */
99         QString format_string();
100
101         void compute_text_size(QPainter &p);
102
103         pair<float, float> get_cursor_offsets() const;
104
105 private:
106         shared_ptr<Cursor> first_, second_;
107
108         QSizeF text_size_;
109 };
110
111 } // namespace trace
112 } // namespace views
113 } // namespace pv
114
115 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_CURSORPAIR_HPP