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