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