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