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 pv {
  33 namespace view {
  34
  35 class TimeItem;
  36 class ViewItem;
  37
  38 class Ruler : public MarginWidget
  39 {
  40         Q_OBJECT
  41
  42 private:
  43
  44         /// Height of the ruler in multipes of the text height
  45         static const float RulerHeight;
  46
  47         static const int MinorTickSubdivision;
  48
  49         /// Height of the hover arrow in multiples of the text height
  50         static const float HoverArrowSize;
  51
  52 public:
  53         Ruler(View &parent);
  54
  55 public:
  56         QSize sizeHint() const;
  57
  58         /**
  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.
  62          */
  63         QSize extended_size_hint() const;
  64
  65 private:
  66         /**
  67          * Gets the time items.
  68          */
  69         std::vector< std::shared_ptr<pv::view::ViewItem> > items();
  70
  71         /**
  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.
  76          */
  77         std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
  78                 const QPoint &pt);
  79
  80 private:
  81         void paintEvent(QPaintEvent *event);
  82
  83         void mouseDoubleClickEvent(QMouseEvent *e);
  84
  85         /**
  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.
  89          */
  90         void draw_hover_mark(QPainter &p, int text_height);
  91
  92         int calculate_text_height() const;
  93
  94         struct TickPositions
  95         {
  96                 std::vector<std::pair<double, QString>> major;
  97                 std::vector<double> minor;
  98         };
  99
 100         /**
 101          * Holds the tick positions so that they don't have to be recalculated on
 102          * every redraw. Set by 'paintEvent()' when needed.
 103          */
 104         boost::optional<TickPositions> tick_position_cache_;
 105
 106         /**
 107          * Calculates the major and minor tick positions.
 108          *
 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
 116          *         tick positions.
 117          */
 118         static TickPositions calculate_tick_positions(
 119                 const double major_period,
 120                 const pv::util::Timestamp& offset,
 121                 const double scale,
 122                 const int width,
 123                 std::function<QString(const pv::util::Timestamp&)> format_function);
 124
 125 protected:
 126         void resizeEvent(QResizeEvent*) override;
 127
 128 private Q_SLOTS:
 129         void hover_point_changed();
 130
 131         // Resets the 'tick_position_cache_'.
 132         void invalidate_tick_position_cache();
 133 };
 134
 135 } // namespace view
 136 } // namespace pv
 137
 138 #endif // PULSEVIEW_PV_VIEW_RULER_HPP