pv/view/trace.h

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