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