2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
21 #ifndef PULSEVIEW_PV_SIGNAL_H
22 #define PULSEVIEW_PV_SIGNAL_H
24 #include <boost/shared_ptr.hpp>
34 #include <libsigrok/libsigrok.h>
36 #include "selectableitem.h"
46 class Signal : public SelectableItem
51 static const int LabelHitPadding;
52 static const int LabelHighlightRadius;
54 static const QPen SignalAxisPen;
57 Signal(const sr_probe *const probe);
61 * Gets the name of this signal.
63 QString get_name() const;
66 * Sets the name of the signal.
68 void set_name(QString name);
71 * Get the colour of the signal.
73 QColor get_colour() const;
76 * Set the colour of the signal.
78 void set_colour(QColor colour);
81 * Gets the vertical layout offset of this signal.
83 int get_v_offset() const;
86 * Sets the vertical layout offset of this signal.
88 void set_v_offset(int v_offset);
91 * Returns true if the signal has been selected by the user.
93 bool selected() const;
96 * Selects or deselects the signal.
98 void select(bool select = true);
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.
110 virtual void paint(QPainter &p, int y, int left, int right,
111 double scale, double offset) = 0;
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
119 * @param hover true if the label is being hovered over by the mouse.
121 virtual void paint_label(QPainter &p, int y, int right,
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
129 * @param right the x-coordinate of the right edge of the header
131 * @param point the point to test.
133 bool pt_in_label_rect(int y, int left, int right,
134 const QPoint &point);
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.
145 void paint_axis(QPainter &p, int y, int left, int right);
150 * Computes an caches the size of the label text.
152 void compute_text_size(QPainter &p);
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
160 * @return Returns the rectangle of the signal label.
162 QRectF get_label_rect(int y, int right);
165 const sr_probe *const _probe;
179 #endif // PULSEVIEW_PV_SIGNAL_H