pv/view/triggermarker.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2014 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_TRIGGER_MARKER_HPP
  22 #define PULSEVIEW_PV_VIEW_TRIGGER_MARKER_HPP
  23
  24 #include "timeitem.hpp"
  25
  26 namespace pv {
  27 namespace view {
  28
  29 class TriggerMarker : public TimeItem
  30 {
  31         Q_OBJECT
  32
  33 public:
  34         static const QColor Colour;
  35
  36 public:
  37         /**
  38          * Constructor.
  39          * @param view A reference to the view that owns this marker.
  40          * @param time The time to set the marker to.
  41          */
  42         TriggerMarker(View &view, const pv::util::Timestamp& time);
  43
  44         /**
  45          * Copy constructor.
  46          */
  47         TriggerMarker(const TriggerMarker &marker);
  48
  49         /**
  50          * Returns true if the item is visible and enabled.
  51          */
  52         bool enabled() const override;
  53
  54         /**
  55           Returns true if the item may be dragged/moved.
  56          */
  57         bool is_draggable() const override;
  58
  59         /**
  60          * Sets the time of the marker.
  61          */
  62         void set_time(const pv::util::Timestamp& time) override;
  63
  64         float get_x() const override;
  65
  66         /**
  67          * Gets the arrow-tip point of the time marker.
  68          * @param rect the rectangle of the ruler area.
  69          */
  70         QPoint point(const QRect &rect) const override;
  71
  72         /**
  73          * Paints the foreground layer of the item with a QPainter
  74          * @param p the QPainter to paint into.
  75          * @param pp the painting parameters object to paint with.
  76          */
  77         void paint_fore(QPainter &p, const ViewItemPaintParams &pp) override;
  78
  79 private:
  80         pv::util::Timestamp time_;
  81 };
  82
  83 } // namespace view
  84 } // namespace pv
  85
  86 #endif // PULSEVIEW_PV_VIEW_TRIGGER_MARKER_HPP