]>
Commit | Line | Data |
---|---|---|
ccdd3ef5 | 1 | /* |
b3f22de0 | 2 | * This file is part of the PulseView project. |
ccdd3ef5 JH |
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 | ||
7a01bd36 JH |
21 | #ifndef PULSEVIEW_PV_VIEW_RULER_HPP |
22 | #define PULSEVIEW_PV_VIEW_RULER_HPP | |
ccdd3ef5 | 23 | |
4b0af0b6 | 24 | #include <functional> |
f9abf97e | 25 | #include <memory> |
58864c5c | 26 | |
4b0af0b6 JS |
27 | #include <boost/optional.hpp> |
28 | ||
2acdb232 | 29 | #include "marginwidget.hpp" |
4b0af0b6 | 30 | #include <pv/util.hpp> |
ccdd3ef5 | 31 | |
c677193d JS |
32 | namespace RulerTest { |
33 | class tick_position_test_0; | |
34 | class tick_position_test_1; | |
35 | class tick_position_test_2; | |
36 | } | |
37 | ||
ccdd3ef5 JH |
38 | namespace pv { |
39 | namespace view { | |
40 | ||
819e2e95 | 41 | class TimeItem; |
6871ee9f | 42 | class ViewItem; |
819e2e95 | 43 | |
c23b29d6 | 44 | class Ruler : public MarginWidget |
ccdd3ef5 JH |
45 | { |
46 | Q_OBJECT | |
47 | ||
c677193d JS |
48 | friend class RulerTest::tick_position_test_0; |
49 | friend class RulerTest::tick_position_test_1; | |
50 | friend class RulerTest::tick_position_test_2; | |
51 | ||
ccdd3ef5 | 52 | private: |
249229ec JH |
53 | |
54 | /// Height of the ruler in multipes of the text height | |
55 | static const float RulerHeight; | |
56 | ||
ccdd3ef5 | 57 | static const int MinorTickSubdivision; |
ccdd3ef5 | 58 | |
415341a1 JH |
59 | /// Height of the hover arrow in multiples of the text height |
60 | static const float HoverArrowSize; | |
b3a7c013 | 61 | |
ccdd3ef5 JH |
62 | public: |
63 | Ruler(View &parent); | |
64 | ||
a6c1726e JH |
65 | public: |
66 | QSize sizeHint() const; | |
67 | ||
819e2e95 JH |
68 | /** |
69 | * The extended area that the header widget would like to be sized to. | |
70 | * @remarks This area is the area specified by sizeHint, extended by | |
71 | * the area to overlap the viewport. | |
72 | */ | |
73 | QSize extended_size_hint() const; | |
74 | ||
3ccf0f7f JS |
75 | /** |
76 | * Formats a timestamp depending on its distance to another timestamp. | |
77 | * | |
78 | * Heuristic function, useful when multiple timestamps should be put side by | |
79 | * side. The function procedes in the following order: | |
80 | * - If 't' is zero, "0" is returned. | |
81 | * - If 'unit' is 'TimeUnit::Samples', 'pv::util::format_time_si_adjusted()' | |
82 | * is used to format 't'. | |
83 | * - If a zoomed out view is detected (determined by 'precision' and | |
84 | * 'distance'), 'pv::util::format_time_minutes() is used. | |
85 | * - For timestamps "near the origin" (determined by 'distance'), | |
86 | * 'pv::util::format_time_si_adjusted()' is used. | |
87 | * - If none of the previous was true, 'pv::util::format_time_minutes()' | |
88 | * is used again. | |
89 | * | |
90 | * @param distance The distance between the timestamp to format and | |
91 | * an adjacent one. | |
92 | * @param t The value to format | |
93 | * @param prefix The SI prefix to use. | |
94 | * @param unit The representation of the timestamp value. | |
95 | * @param precision The number of digits after the decimal separator. | |
96 | * @param sign Whether or not to add a sign also for positive numbers. | |
97 | * | |
98 | * @return The formated value. | |
99 | */ | |
100 | static QString format_time_with_distance( | |
101 | const pv::util::Timestamp& distance, | |
102 | const pv::util::Timestamp& t, | |
103 | pv::util::SIPrefix prefix = pv::util::SIPrefix::unspecified, | |
104 | pv::util::TimeUnit unit = pv::util::TimeUnit::Time, | |
105 | unsigned precision = 0, | |
106 | bool sign = true); | |
107 | ||
25a0d47c | 108 | private: |
3e124bee JH |
109 | /** |
110 | * Gets the time items. | |
111 | */ | |
112 | std::vector< std::shared_ptr<pv::view::ViewItem> > items(); | |
113 | ||
6871ee9f JH |
114 | /** |
115 | * Gets the first view item which has a label that contains @c pt . | |
116 | * @param pt the point to search with. | |
117 | * @return the view item that has been found, or and empty | |
118 | * @c shared_ptr if no item was found. | |
119 | */ | |
120 | std::shared_ptr<pv::view::ViewItem> get_mouse_over_item( | |
25a0d47c JH |
121 | const QPoint &pt); |
122 | ||
ccdd3ef5 JH |
123 | void paintEvent(QPaintEvent *event); |
124 | ||
819e2e95 JH |
125 | void mouseDoubleClickEvent(QMouseEvent *e); |
126 | ||
b3a7c013 JH |
127 | /** |
128 | * Draw a hover arrow under the cursor position. | |
249229ec JH |
129 | * @param p The painter to draw into. |
130 | * @param text_height The height of a single text ascent. | |
b3a7c013 | 131 | */ |
249229ec | 132 | void draw_hover_mark(QPainter &p, int text_height); |
b3a7c013 | 133 | |
e456e8e1 | 134 | int calculate_text_height() const; |
819e2e95 | 135 | |
4b0af0b6 JS |
136 | struct TickPositions |
137 | { | |
138 | std::vector<std::pair<double, QString>> major; | |
139 | std::vector<double> minor; | |
140 | }; | |
141 | ||
142 | /** | |
143 | * Holds the tick positions so that they don't have to be recalculated on | |
144 | * every redraw. Set by 'paintEvent()' when needed. | |
145 | */ | |
146 | boost::optional<TickPositions> tick_position_cache_; | |
147 | ||
148 | /** | |
149 | * Calculates the major and minor tick positions. | |
150 | * | |
151 | * @param major_period The period between the major ticks. | |
152 | * @param offset The time at the left border of the ruler. | |
153 | * @param scale The scale in seconds per pixel. | |
154 | * @param width the Width of the ruler. | |
155 | * @param format_function A function used to format the major tick times. | |
156 | * @return An object of type 'TickPositions' that contains the major tick | |
157 | * positions together with the labels at that ticks, and the minor | |
158 | * tick positions. | |
159 | */ | |
160 | static TickPositions calculate_tick_positions( | |
c677193d | 161 | const pv::util::Timestamp& major_period, |
4b0af0b6 JS |
162 | const pv::util::Timestamp& offset, |
163 | const double scale, | |
164 | const int width, | |
165 | std::function<QString(const pv::util::Timestamp&)> format_function); | |
166 | ||
167 | protected: | |
168 | void resizeEvent(QResizeEvent*) override; | |
169 | ||
e9213170 | 170 | private Q_SLOTS: |
b3a7c013 | 171 | void hover_point_changed(); |
4b0af0b6 JS |
172 | |
173 | // Resets the 'tick_position_cache_'. | |
174 | void invalidate_tick_position_cache(); | |
ccdd3ef5 JH |
175 | }; |
176 | ||
177 | } // namespace view | |
178 | } // namespace pv | |
179 | ||
7a01bd36 | 180 | #endif // PULSEVIEW_PV_VIEW_RULER_HPP |