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