pv/view/timemarker.h

   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_MARKER_H
  22 #define PULSEVIEW_PV_VIEW_MARKER_H
  23
  24 #include <QColor>
  25 #include <QDoubleSpinBox>
  26 #include <QObject>
  27 #include <QRectF>
  28 #include <QWidgetAction>
  29
  30 #include "selectableitem.h"
  31
  32 class QPainter;
  33 class QRect;
  34
  35 namespace pv {
  36 namespace view {
  37
  38 class View;
  39
  40 class TimeMarker : public SelectableItem
  41 {
  42         Q_OBJECT
  43
  44 protected:
  45         /**
  46          * Constructor.
  47          * @param view A reference to the view that owns this marker.
  48          * @param colour A reference to the colour of this cursor.
  49          * @param time The time to set the flag to.
  50          */
  51         TimeMarker(View &view, const QColor &colour, double time);
  52
  53 public:
  54         virtual void init_context_bar_actions(QWidget *parent);
  55
  56         /**
  57          * Gets the time of the marker.
  58          */
  59         double time() const;
  60
  61         /**
  62          * Sets the time of the marker.
  63          */
  64         void set_time(double time);
  65
  66         /**
  67          * Paints the marker to the viewport.
  68          * @param p The painter to draw with.
  69          * @param rect The rectangle of the viewport client area.
  70          */
  71         virtual void paint(QPainter &p, const QRect &rect);
  72
  73         /**
  74          * Gets the marker label rectangle.
  75          * @param rect The rectangle of the ruler client area.
  76          * @return Returns the label rectangle.
  77          */
  78         virtual QRectF get_label_rect(const QRect &rect) const = 0;
  79
  80         /**
  81          * Paints the marker's label to the ruler.
  82          * @param p The painter to draw with.
  83          * @param rect The rectangle of the ruler client area.
  84          * @param prefix The SI prefix to paint time value with.
  85          */
  86         virtual void paint_label(QPainter &p, const QRect &rect,
  87                 unsigned int prefix) = 0;
  88
  89         /**
  90          * Returns a list of context menu items to show in the context
  91          * bar.
  92          */
  93         const std::list<QAction*> get_context_bar_actions();
  94
  95 private slots:
  96         void on_value_changed(double value);
  97
  98 signals:
  99         void time_changed();
 100
 101 protected:
 102         View &_view;
 103         const QColor &_colour;
 104
 105         double _time;
 106
 107         QSizeF _text_size;
 108
 109         QWidgetAction *_value_action;
 110         QDoubleSpinBox *_value_widget;
 111         bool _updating_value_widget;
 112 };
 113
 114 } // namespace view
 115 } // namespace pv
 116
 117 #endif // PULSEVIEW_PV_VIEW_MARKER_H