pv/view/ruler.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, 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_RULER_HPP
  22 #define PULSEVIEW_PV_VIEW_RULER_HPP
  23
  24 #include <functional>
  25 #include <memory>
  26
  27 #include <boost/optional.hpp>
  28
  29 #include "marginwidget.hpp"
  30 #include <pv/util.hpp>
  31
  32 namespace RulerTest {
  33 class tick_position_test_0;
  34 class tick_position_test_1;
  35 class tick_position_test_2;
  36 }
  37
  38 namespace pv {
  39 namespace view {
  40
  41 class TimeItem;
  42 class ViewItem;
  43
  44 class Ruler : public MarginWidget
  45 {
  46         Q_OBJECT
  47
  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
  52 private:
  53
  54         /// Height of the ruler in multipes of the text height
  55         static const float RulerHeight;
  56
  57         static const int MinorTickSubdivision;
  58
  59         /// Height of the hover arrow in multiples of the text height
  60         static const float HoverArrowSize;
  61
  62 public:
  63         Ruler(View &parent);
  64
  65 public:
  66         QSize sizeHint() const;
  67
  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
  75 private:
  76         /**
  77          * Gets the time items.
  78          */
  79         std::vector< std::shared_ptr<pv::view::ViewItem> > items();
  80
  81         /**
  82          * Gets the first view item which has a label that contains @c pt .
  83          * @param pt the point to search with.
  84          * @return the view item that has been found, or and empty
  85          *   @c shared_ptr if no item was found.
  86          */
  87         std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
  88                 const QPoint &pt);
  89
  90 private:
  91         void paintEvent(QPaintEvent *event);
  92
  93         void mouseDoubleClickEvent(QMouseEvent *e);
  94
  95         /**
  96          * Draw a hover arrow under the cursor position.
  97          * @param p The painter to draw into.
  98          * @param text_height The height of a single text ascent.
  99          */
 100         void draw_hover_mark(QPainter &p, int text_height);
 101
 102         int calculate_text_height() const;
 103
 104         struct TickPositions
 105         {
 106                 std::vector<std::pair<double, QString>> major;
 107                 std::vector<double> minor;
 108         };
 109
 110         /**
 111          * Holds the tick positions so that they don't have to be recalculated on
 112          * every redraw. Set by 'paintEvent()' when needed.
 113          */
 114         boost::optional<TickPositions> tick_position_cache_;
 115
 116         /**
 117          * Calculates the major and minor tick positions.
 118          *
 119          * @param major_period The period between the major ticks.
 120          * @param offset The time at the left border of the ruler.
 121          * @param scale The scale in seconds per pixel.
 122          * @param width the Width of the ruler.
 123          * @param format_function A function used to format the major tick times.
 124          * @return An object of type 'TickPositions' that contains the major tick
 125          *         positions together with the labels at that ticks, and the minor
 126          *         tick positions.
 127          */
 128         static TickPositions calculate_tick_positions(
 129                 const pv::util::Timestamp& major_period,
 130                 const pv::util::Timestamp& offset,
 131                 const double scale,
 132                 const int width,
 133                 std::function<QString(const pv::util::Timestamp&)> format_function);
 134
 135 protected:
 136         void resizeEvent(QResizeEvent*) override;
 137
 138 private Q_SLOTS:
 139         void hover_point_changed();
 140
 141         // Resets the 'tick_position_cache_'.
 142         void invalidate_tick_position_cache();
 143 };
 144
 145 } // namespace view
 146 } // namespace pv
 147
 148 #endif // PULSEVIEW_PV_VIEW_RULER_HPP