pv/views/trace/trace.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2013 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_TRACE_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACE_TRACE_HPP
  22
  23 #include <QColor>
  24 #include <QPainter>
  25 #include <QPen>
  26 #include <QRect>
  27 #include <QString>
  28
  29 #include <cstdint>
  30
  31 #include "tracetreeitem.hpp"
  32
  33 #include <pv/globalsettings.hpp>
  34 #include "pv/data/signalbase.hpp"
  35
  36 using std::shared_ptr;
  37
  38 class QFormLayout;
  39
  40 namespace pv {
  41
  42 namespace data {
  43 class SignalBase;
  44 }
  45
  46 namespace widgets {
  47 class Popup;
  48 }
  49
  50 namespace views {
  51 namespace trace {
  52
  53 /**
  54  * The Trace class represents a @ref TraceTreeItem which occupies some vertical
  55  * space on the canvas and spans across its entire width, essentially showing
  56  * a time series of values, events, objects or similar. While easily confused
  57  * with @ref Signal, the difference is that Trace may represent anything that
  58  * can be drawn, not just numeric values. One example is a @ref DecodeTrace.
  59  *
  60  * For this reason, Trace is more generic and contains properties and helpers
  61  * that benefit any kind of time series items.
  62  */
  63 class Trace : public TraceTreeItem, public GlobalSettingsInterface
  64 {
  65         Q_OBJECT
  66
  67 public:
  68         /**
  69          * Allowed values for the multi-segment display mode.
  70          *
  71          * Note: Consider these locations when updating the list:
  72          * *
  73          * @ref View::set_segment_display_mode
  74          * @ref View::on_segment_changed
  75          * @ref AnalogSignal::get_analog_segment_to_paint
  76          * @ref AnalogSignal::get_logic_segment_to_paint
  77          * @ref LogicSignal::get_logic_segment_to_paint
  78          * @ref StandardBar
  79          */
  80         enum SegmentDisplayMode {
  81                 ShowLastSegmentOnly = 1,
  82                 ShowLastCompleteSegmentOnly,
  83                 ShowSingleSegmentOnly,
  84                 ShowAllSegments,
  85                 ShowAccumulatedIntensity
  86         };
  87
  88 private:
  89         static const QPen AxisPen;
  90         static const int LabelHitPadding;
  91
  92         static const QColor BrightGrayBGColor;
  93         static const QColor DarkGrayBGColor;
  94         static const QColor ErrorBgColor;
  95
  96 protected:
  97         Trace(shared_ptr<data::SignalBase> signal);
  98         ~Trace();
  99
 100 public:
 101         /**
 102          * Returns the underlying SignalBase instance.
 103          */
 104         shared_ptr<data::SignalBase> base() const;
 105
 106         /**
 107          * Returns true if the item may be selected.
 108          */
 109         virtual bool is_selectable(QPoint pos) const;
 110
 111         /**
 112          * Returns true if the item may be dragged/moved.
 113          */
 114         virtual bool is_draggable(QPoint pos) const;
 115
 116         /**
 117          * Configures the segment display mode to use.
 118          */
 119         virtual void set_segment_display_mode(SegmentDisplayMode mode);
 120
 121         virtual void on_setting_changed(const QString &key, const QVariant &value);
 122
 123         /**
 124          * Paints the signal label.
 125          * @param p the QPainter to paint into.
 126          * @param rect the rectangle of the header area.
 127          * @param hover true if the label is being hovered over by the mouse.
 128          */
 129         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
 130
 131         /**
 132          * Paints the signal's current error message text.
 133          * @param p the QPainter to paint into.
 134          * @param pp The painting parameters object to paint with.
 135          */
 136         virtual void paint_error(QPainter &p, const ViewItemPaintParams &pp);
 137
 138         virtual QMenu* create_header_context_menu(QWidget *parent);
 139
 140         virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
 141
 142         pv::widgets::Popup* create_popup(QWidget *parent);
 143
 144         /**
 145          * Computes the outline rectangle of a label.
 146          * @param rect the rectangle of the header area.
 147          * @return Returns the rectangle of the signal label.
 148          */
 149         QRectF label_rect(const QRectF &rect) const;
 150
 151         /**
 152          * Computes the outline rectangle of the viewport hit-box.
 153          * @param pp The painting parameters object to paint with.
 154          * @return Returns the rectangle of the hit-box.
 155          * @remarks The default implementation returns an empty hit-box.
 156          */
 157         virtual QRectF hit_box_rect(const ViewItemPaintParams &pp) const;
 158
 159         void set_current_segment(const int segment);
 160
 161         int get_current_segment() const;
 162
 163         virtual void hover_point_changed(const QPoint &hp);
 164
 165 protected:
 166         /**
 167          * Paints the background layer of the signal with a QPainter.
 168          * @param p The QPainter to paint into.
 169          * @param pp The painting parameters object to paint with.
 170          */
 171         virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
 172
 173         /**
 174          * Paints a zero axis across the viewport.
 175          * @param p the QPainter to paint into.
 176          * @param pp the painting parameters object to paint with.
 177          * @param y the y-offset of the axis.
 178          */
 179         void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
 180
 181         /**
 182          * Draw a hover marker under the cursor position.
 183          * @param p The painter to draw into.
 184          */
 185         void paint_hover_marker(QPainter &p);
 186
 187         void add_color_option(QWidget *parent, QFormLayout *form);
 188
 189         void create_popup_form();
 190
 191         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
 192
 193 protected Q_SLOTS:
 194         virtual void on_name_changed(const QString &text);
 195         virtual void on_color_changed(const QColor &color);
 196         virtual void on_error_message_changed(const QString &msg);
 197
 198         void on_popup_closed();
 199
 200 private Q_SLOTS:
 201         void on_nameedit_changed(const QString &name);
 202
 203         void on_coloredit_changed(const QColor &color);
 204
 205         void on_create_marker_here() const;
 206
 207 protected:
 208         shared_ptr<data::SignalBase> base_;
 209         QPen axis_pen_;
 210
 211         SegmentDisplayMode segment_display_mode_;
 212         bool show_hover_marker_;
 213
 214         uint32_t context_menu_x_pos_;
 215
 216         /// The ID of the currently displayed segment
 217         int current_segment_;
 218
 219 private:
 220         pv::widgets::Popup *popup_;
 221         QFormLayout *popup_form_;
 222 };
 223
 224 } // namespace trace
 225 } // namespace views
 226 } // namespace pv
 227
 228 #endif // PULSEVIEW_PV_VIEWS_TRACE_TRACE_HPP