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