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