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