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