2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
21 #ifndef PULSEVIEW_PV_VIEW_RULER_HPP
22 #define PULSEVIEW_PV_VIEW_RULER_HPP
27 #include <boost/optional.hpp>
29 #include "marginwidget.hpp"
30 #include <pv/util.hpp>
38 class Ruler : public MarginWidget
44 /// Height of the ruler in multipes of the text height
45 static const float RulerHeight;
47 static const int MinorTickSubdivision;
49 /// Height of the hover arrow in multiples of the text height
50 static const float HoverArrowSize;
56 QSize sizeHint() const;
59 * The extended area that the header widget would like to be sized to.
60 * @remarks This area is the area specified by sizeHint, extended by
61 * the area to overlap the viewport.
63 QSize extended_size_hint() const;
67 * Gets the time items.
69 std::vector< std::shared_ptr<pv::view::ViewItem> > items();
72 * Gets the first view item which has a label that contains @c pt .
73 * @param pt the point to search with.
74 * @return the view item that has been found, or and empty
75 * @c shared_ptr if no item was found.
77 std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
81 void paintEvent(QPaintEvent *event);
83 void mouseDoubleClickEvent(QMouseEvent *e);
86 * Draw a hover arrow under the cursor position.
87 * @param p The painter to draw into.
88 * @param text_height The height of a single text ascent.
90 void draw_hover_mark(QPainter &p, int text_height);
92 int calculate_text_height() const;
96 std::vector<std::pair<double, QString>> major;
97 std::vector<double> minor;
101 * Holds the tick positions so that they don't have to be recalculated on
102 * every redraw. Set by 'paintEvent()' when needed.
104 boost::optional<TickPositions> tick_position_cache_;
107 * Calculates the major and minor tick positions.
109 * @param major_period The period between the major ticks.
110 * @param offset The time at the left border of the ruler.
111 * @param scale The scale in seconds per pixel.
112 * @param width the Width of the ruler.
113 * @param format_function A function used to format the major tick times.
114 * @return An object of type 'TickPositions' that contains the major tick
115 * positions together with the labels at that ticks, and the minor
118 static TickPositions calculate_tick_positions(
119 const double major_period,
120 const pv::util::Timestamp& offset,
123 std::function<QString(const pv::util::Timestamp&)> format_function);
126 void resizeEvent(QResizeEvent*) override;
129 void hover_point_changed();
131 // Resets the 'tick_position_cache_'.
132 void invalidate_tick_position_cache();
138 #endif // PULSEVIEW_PV_VIEW_RULER_HPP