pv/view/timemarker.hpp

   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_HPP
  22 #define PULSEVIEW_PV_VIEW_MARKER_HPP
  23
  24 #include <QColor>
  25 #include <QDoubleSpinBox>
  26 #include <QObject>
  27 #include <QRectF>
  28 #include <QWidgetAction>
  29
  30 #include "timeitem.hpp"
  31
  32 class QPainter;
  33 class QRect;
  34
  35 namespace pv {
  36 namespace widgets {
  37         class TimestampSpinBox;
  38 }
  39
  40 namespace view {
  41
  42 class View;
  43
  44 class TimeMarker : public TimeItem
  45 {
  46         Q_OBJECT
  47
  48 public:
  49         static const int ArrowSize;
  50
  51 protected:
  52         /**
  53          * Constructor.
  54          * @param view A reference to the view that owns this marker.
  55          * @param colour A reference to the colour of this cursor.
  56          * @param time The time to set the flag to.
  57          */
  58         TimeMarker(View &view, const QColor &colour, const pv::util::Timestamp& time);
  59
  60 public:
  61         /**
  62          * Gets the time of the marker.
  63          */
  64         const pv::util::Timestamp& time() const;
  65
  66         /**
  67          * Sets the time of the marker.
  68          */
  69         void set_time(const pv::util::Timestamp& time) override;
  70
  71         float get_x() const;
  72
  73         /**
  74          * Gets the arrow-tip point of the time marker.
  75          * @param rect the rectangle of the ruler area.
  76          */
  77         QPoint point(const QRect &rect) const;
  78
  79         /**
  80          * Computes the outline rectangle of a label.
  81          * @param rect the rectangle of the header area.
  82          * @return Returns the rectangle of the signal label.
  83          */
  84         QRectF label_rect(const QRectF &rect) const;
  85
  86         /**
  87          * Computes the outline rectangle of the viewport hit-box.
  88          * @param rect the rectangle of the viewport area.
  89          * @return Returns the rectangle of the hit-box.
  90          */
  91         QRectF hit_box_rect(const ViewItemPaintParams &pp) const;
  92
  93         /**
  94          * Gets the text to show in the marker.
  95          */
  96         virtual QString get_text() const = 0;
  97
  98         /**
  99          * Paints the marker's label to the ruler.
 100          * @param p The painter to draw with.
 101          * @param rect The rectangle of the ruler client area.
 102          * @param hover true if the label is being hovered over by the mouse.
 103          */
 104         void paint_label(QPainter &p, const QRect &rect, bool hover);
 105
 106         /**
 107          * Paints the foreground layer of the item with a QPainter
 108          * @param p the QPainter to paint into.
 109          * @param pp the painting parameters object to paint with.
 110          **/
 111         void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
 112
 113         virtual pv::widgets::Popup* create_popup(QWidget *parent);
 114
 115 private Q_SLOTS:
 116         void on_value_changed(const pv::util::Timestamp& value);
 117
 118 protected:
 119         const QColor &colour_;
 120
 121         pv::util::Timestamp time_;
 122
 123         QSizeF text_size_;
 124
 125         QWidgetAction *value_action_;
 126         pv::widgets::TimestampSpinBox *value_widget_;
 127         bool updating_value_widget_;
 128 };
 129
 130 } // namespace view
 131 } // namespace pv
 132
 133 #endif // PULSEVIEW_PV_VIEW_MARKER_HPP