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 <QObject>
  26 #include <QRectF>
  27
  28 class QPainter;
  29 class QRect;
  30
  31 namespace pv {
  32 namespace view {
  33
  34 class View;
  35
  36 class TimeMarker : public QObject
  37 {
  38         Q_OBJECT
  39
  40 protected:
  41         /**
  42          * Constructor.
  43          * @param view A reference to the view that owns this marker.
  44          * @param colour A reference to the colour of this cursor.
  45          * @param time The time to set the flag to.
  46          */
  47         TimeMarker(const View &view, const QColor &colour, double time);
  48
  49         /**
  50          * Copy constructor
  51          */
  52         TimeMarker(const TimeMarker &s);
  53
  54 public:
  55         /**
  56          * Gets the time of the marker.
  57          */
  58         double time() const;
  59
  60         /**
  61          * Sets the time of the marker.
  62          */
  63         void set_time(double time);
  64
  65         /**
  66          * Paints the marker to the viewport.
  67          * @param p The painter to draw with.
  68          * @param rect The rectangle of the viewport client area.
  69          */
  70         virtual void paint(QPainter &p, const QRect &rect);
  71
  72         /**
  73          * Gets the marker label rectangle.
  74          * @param rect The rectangle of the ruler client area.
  75          * @return Returns the label rectangle.
  76          */
  77         virtual QRectF get_label_rect(const QRect &rect) const = 0;
  78
  79         /**
  80          * Paints the marker's label to the ruler.
  81          * @param p The painter to draw with.
  82          * @param rect The rectangle of the ruler client area.
  83          */
  84         virtual void paint_label(QPainter &p, const QRect &rect) = 0;
  85
  86 signals:
  87         void time_changed();
  88
  89 protected:
  90         const View &_view;
  91         const QColor &_colour;
  92
  93         double _time;
  94
  95         QSizeF _text_size;
  96 };
  97
  98 } // namespace view
  99 } // namespace pv
 100
 101 #endif // PULSEVIEW_PV_VIEW_MARKER_H