pv/views/trace/timeitem.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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_VIEWS_TRACE_TIMEITEM_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACE_TIMEITEM_HPP
  22
  23 #include "viewitem.hpp"
  24
  25 namespace pv {
  26 namespace views {
  27 namespace trace {
  28
  29 class View;
  30
  31 /**
  32  * The TimeItem class represents items on the @ref Ruler. It is generic in
  33  * nature, not making assumptions about the kind of item shown.
  34  */
  35 class TimeItem : public ViewItem
  36 {
  37         Q_OBJECT
  38
  39 protected:
  40         /**
  41          * Constructor.
  42          * @param view A reference to the view that owns this marker.
  43          */
  44         TimeItem(View &view);
  45
  46         bool snapping_disabled_ = false;
  47
  48 public:
  49         /**
  50          * Sets the time of the marker.
  51          */
  52         virtual void set_time(const pv::util::Timestamp& time) = 0;
  53
  54         /**
  55          * Returns the time this time item is set to.
  56          * @return 0 in case there is no valid time (e.g. for a cursor pair)
  57          */
  58         virtual const pv::util::Timestamp time() const = 0;
  59
  60         virtual float get_x() const = 0;
  61
  62         virtual const pv::util::Timestamp delta(const pv::util::Timestamp& other) const;
  63
  64         /**
  65          * Drags the item to a delta relative to the drag point.
  66          * @param delta the offset from the drag point.
  67          */
  68         void drag_by(const QPoint &delta);
  69
  70         bool is_snapping_disabled() const;
  71
  72 protected:
  73         View &view_;
  74 };
  75
  76 } // namespace trace
  77 } // namespace views
  78 } // namespace pv
  79
  80 #endif // PULSEVIEW_PV_VIEWS_TRACE_TIMEITEM_HPP