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