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 <QRect>
  29 #include <QString>
  30
  31 #include <stdint.h>
  32
  33 namespace pv {
  34
  35 namespace data {
  36 class SignalData;
  37 }
  38
  39 namespace view {
  40
  41 class Signal
  42 {
  43 private:
  44         static const int LabelHitPadding;
  45         static const int LabelHighlightRadius;
  46
  47 protected:
  48         Signal(QString name);
  49
  50 public:
  51         /**
  52          * Gets the name of this signal.
  53          */
  54         QString get_name() const;
  55
  56         /**
  57          * Sets the name of the signal.
  58          */
  59         void set_name(QString name);
  60
  61         /**
  62          * Get the colour of the signal.
  63          */
  64         QColor get_colour() const;
  65
  66         /**
  67          * Set the colour of the signal.
  68          */
  69         void set_colour(QColor colour);
  70
  71         /**
  72          * Gets the vertical layout offset of this signal.
  73          */
  74         int get_v_offset() const;
  75
  76         /**
  77          * Sets the vertical layout offset of this signal.
  78          */
  79         void set_v_offset(int v_offset);
  80
  81         /**
  82          * Returns true if the signal has been selected by the user.
  83          */
  84         bool selected() const;
  85
  86         /**
  87          * Selects or deselects the signal.
  88          */
  89         void select(bool select = true);
  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 private:
 128
 129         /**
 130          * Computes an caches the size of the label text.
 131          */
 132         void compute_text_size(QPainter &p);
 133
 134         /**
 135          * Computes the outline rectangle of a label.
 136          * @param p the QPainter to lay out text with.
 137          * @param y the y-coordinate of the signal.
 138          * @param right the x-coordinate of the right edge of the header
 139          *      area.
 140          * @return Returns the rectangle of the signal label.
 141          */
 142         QRectF get_label_rect(int y, int right);
 143
 144 protected:
 145         QString _name;
 146         QColor _colour;
 147         int _v_offset;
 148
 149         bool _selected;
 150
 151         QSizeF _text_size;
 152 };
 153
 154 } // namespace view
 155 } // namespace pv
 156
 157 #endif // PULSEVIEW_PV_SIGNAL_H