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