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          * Returns true if the item may be dragged/moved.
  86          */
  87         bool is_draggable() const;
  88
  89         /**
  90          * Selects or deselects the signal.
  91          */
  92         void select(bool select = true);
  93
  94         /**
  95          * Computes the outline rectangle of the viewport hit-box.
  96          * @param rect the rectangle of the viewport area.
  97          * @return Returns the rectangle of the hit-box.
  98          */
  99         QRectF hit_box_rect(const ViewItemPaintParams &pp) const;
 100
 101         /**
 102          * Paints the signal label.
 103          * @param p the QPainter to paint into.
 104          * @param rect the rectangle of the header area.
 105          * @param hover true if the label is being hovered over by the mouse.
 106          */
 107         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
 108
 109         virtual QMenu* create_context_menu(QWidget *parent);
 110
 111         pv::widgets::Popup* create_popup(QWidget *parent);
 112
 113         /**
 114          * Computes the outline rectangle of a label.
 115          * @param rect the rectangle of the header area.
 116          * @return Returns the rectangle of the signal label.
 117          */
 118         QRectF label_rect(const QRectF &rect) const;
 119
 120 protected:
 121         /**
 122          * Paints the background layer of the signal with a QPainter.
 123          * @param p The QPainter to paint into.
 124          * @param pp The painting parameters object to paint with.
 125          */
 126         virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp);
 127
 128         /**
 129          * Paints a zero axis across the viewport.
 130          * @param p the QPainter to paint into.
 131          * @param pp the painting parameters object to paint with.
 132          * @param y the y-offset of the axis.
 133          */
 134         void paint_axis(QPainter &p, const ViewItemPaintParams &pp, int y);
 135
 136         void add_colour_option(QWidget *parent, QFormLayout *form);
 137
 138         void create_popup_form();
 139
 140         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
 141
 142 private Q_SLOTS:
 143         void on_text_changed(const QString &text);
 144
 145         void on_colour_changed(const QColor &colour);
 146
 147         void on_popup_closed();
 148
 149 protected:
 150         QString name_;
 151         QColor colour_, bgcolour_;
 152         bool coloured_bg_, coloured_bg_state_;
 153
 154 private:
 155         pv::widgets::Popup *popup_;
 156         QFormLayout *popup_form_;
 157 };
 158
 159 } // namespace view
 160 } // namespace pv
 161
 162 #endif // PULSEVIEW_PV_VIEW_TRACE_HPP