pv/view/signal.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 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_SIGNAL_H
  22 #define PULSEVIEW_PV_SIGNAL_H
  23
  24 #include <boost/shared_ptr.hpp>
  25
  26 #include <QColor>
  27 #include <QComboBox>
  28 #include <QPainter>
  29 #include <QPen>
  30 #include <QRect>
  31 #include <QString>
  32 #include <QWidgetAction>
  33
  34 #include <stdint.h>
  35
  36 #include <libsigrok/libsigrok.h>
  37
  38 #include "selectableitem.h"
  39
  40 namespace pv {
  41
  42 namespace data {
  43 class SignalData;
  44 }
  45
  46 namespace view {
  47
  48 class Signal : public SelectableItem
  49 {
  50         Q_OBJECT
  51
  52 private:
  53         static const int LabelHitPadding;
  54
  55         static const QPen SignalAxisPen;
  56
  57 protected:
  58         Signal(const sr_probe *const probe);
  59
  60 public:
  61         /**
  62          * Gets the name of this signal.
  63          */
  64         QString get_name() const;
  65
  66         /**
  67          * Sets the name of the signal.
  68          */
  69         void set_name(QString name);
  70
  71         /**
  72          * Get the colour of the signal.
  73          */
  74         QColor get_colour() const;
  75
  76         /**
  77          * Set the colour of the signal.
  78          */
  79         void set_colour(QColor colour);
  80
  81         /**
  82          * Gets the vertical layout offset of this signal.
  83          */
  84         int get_v_offset() const;
  85
  86         /**
  87          * Sets the vertical layout offset of this signal.
  88          */
  89         void set_v_offset(int v_offset);
  90
  91         /**
  92          * Paints the signal with a QPainter
  93          * @param p the QPainter to paint into.
  94          * @param y the y-coordinate to draw the signal at
  95          * @param left the x-coordinate of the left edge of the signal
  96          * @param right the x-coordinate of the right edge of the signal
  97          * @param scale the scale in seconds per pixel.
  98          * @param offset the time to show at the left hand edge of
  99          *   the view in seconds.
 100          **/
 101         virtual void paint(QPainter &p, int y, int left, int right,
 102                 double scale, double offset) = 0;
 103
 104         /**
 105          * Paints the signal label into a QGLWidget.
 106          * @param p the QPainter to paint into.
 107          * @param y the y-coordinate of the signal.
 108          * @param right the x-coordinate of the right edge of the header
 109          *      area.
 110          * @param hover true if the label is being hovered over by the mouse.
 111          */
 112         virtual void paint_label(QPainter &p, int y, int right,
 113                 bool hover);
 114
 115         /**
 116          * Determines if a point is in the header label rect.
 117          * @param y the y-coordinate of the signal.
 118          * @param left the x-coordinate of the left edge of the header
 119          *      area.
 120          * @param right the x-coordinate of the right edge of the header
 121          *      area.
 122          * @param point the point to test.
 123          */
 124         bool pt_in_label_rect(int y, int left, int right,
 125                 const QPoint &point);
 126
 127 protected:
 128
 129         /**
 130          * Paints a zero axis across the viewport.
 131          * @param p the QPainter to paint into.
 132          * @param y the y-offset of the axis.
 133          * @param left the x-coordinate of the left edge of the view.
 134          * @param right the x-coordinate of the right edge of the view.
 135          */
 136         void paint_axis(QPainter &p, int y, int left, int right);
 137
 138 private:
 139
 140         /**
 141          * Computes an caches the size of the label text.
 142          */
 143         void compute_text_size(QPainter &p);
 144
 145         /**
 146          * Computes the outline rectangle of a label.
 147          * @param p the QPainter to lay out text with.
 148          * @param y the y-coordinate of the signal.
 149          * @param right the x-coordinate of the right edge of the header
 150          *      area.
 151          * @return Returns the rectangle of the signal label.
 152          */
 153         QRectF get_label_rect(int y, int right);
 154
 155 private slots:
 156         void on_text_changed(const QString &text);
 157
 158 signals:
 159         void text_changed();
 160
 161 protected:
 162         const sr_probe *const _probe;
 163
 164         QString _name;
 165         QColor _colour;
 166         int _v_offset;
 167
 168         QSizeF _text_size;
 169
 170         QWidgetAction _name_action;
 171         QComboBox _name_widget;
 172         bool _updating_name_widget;
 173 };
 174
 175 } // namespace view
 176 } // namespace pv
 177
 178 #endif // PULSEVIEW_PV_SIGNAL_H