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