pv/view/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_TRACEVIEW_TRACE_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_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/data/signalbase.hpp"
  34
  35 using std::shared_ptr;
  36
  37 class QFormLayout;
  38
  39 namespace pv {
  40
  41 namespace data {
  42 class SignalBase;
  43 }
  44
  45 namespace widgets {
  46 class Popup;
  47 }
  48
  49 namespace views {
  50 namespace TraceView {
  51
  52 class Trace : public TraceTreeItem
  53 {
  54         Q_OBJECT
  55
  56 private:
  57         static const QPen AxisPen;
  58         static const int LabelHitPadding;
  59
  60         static const QColor BrightGrayBGColour;
  61         static const QColor DarkGrayBGColour;
  62
  63 protected:
  64         Trace(shared_ptr<data::SignalBase> channel);
  65
  66 public:
  67         /**
  68          * Returns the underlying SignalBase instance.
  69          */
  70         shared_ptr<data::SignalBase> base() const;
  71
  72         /**
  73          * Sets the name of the signal.
  74          */
  75         virtual void set_name(QString name);
  76
  77         /**
  78          * Set the colour of the signal.
  79          */
  80         virtual void set_colour(QColor colour);
  81
  82         /**
  83          * Paints the signal label.
  84          * @param p the QPainter to paint into.
  85          * @param rect the rectangle of the header area.
  86          * @param hover true if the label is being hovered over by the mouse.
  87          */
  88         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
  89
  90         virtual QMenu* create_context_menu(QWidget *parent);
  91
  92         pv::widgets::Popup* create_popup(QWidget *parent);
  93
  94         /**
  95          * Computes the outline rectangle of a label.
  96          * @param rect the rectangle of the header area.
  97          * @return Returns the rectangle of the signal label.
  98          */
  99         QRectF label_rect(const QRectF &rect) const;
 100
 101 protected:
 102         /**
 103          * Paints the background layer of the signal with a QPainter.
 104          * @param p The QPainter to paint into.
 105          * @param pp The painting parameters object to paint with.
 106          */
 107         virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
 108
 109         /**
 110          * Paints a zero axis across the viewport.
 111          * @param p the QPainter to paint into.
 112          * @param pp the painting parameters object to paint with.
 113          * @param y the y-offset of the axis.
 114          */
 115         void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
 116
 117         void add_colour_option(QWidget *parent, QFormLayout *form);
 118
 119         void create_popup_form();
 120
 121         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
 122
 123 protected Q_SLOTS:
 124         virtual void on_name_changed(const QString &text);
 125
 126         virtual void on_colour_changed(const QColor &colour);
 127
 128         void on_popup_closed();
 129
 130 private Q_SLOTS:
 131         void on_nameedit_changed(const QString &name);
 132
 133         void on_colouredit_changed(const QColor &colour);
 134
 135 protected:
 136         shared_ptr<data::SignalBase> base_;
 137
 138 private:
 139         pv::widgets::Popup *popup_;
 140         QFormLayout *popup_form_;
 141 };
 142
 143 } // namespace TraceView
 144 } // namespace views
 145 } // namespace pv
 146
 147 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP