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
49 static const int LabelHitPadding;
50 static const int LabelHighlightRadius;
52 static const QPen SignalAxisPen;
55 Signal(const sr_probe *const probe);
59 * Gets the name of this signal.
61 QString get_name() const;
64 * Sets the name of the signal.
66 void set_name(QString name);
69 * Get the colour of the signal.
71 QColor get_colour() const;
74 * Set the colour of the signal.
76 void set_colour(QColor colour);
79 * Gets the vertical layout offset of this signal.
81 int get_v_offset() const;
84 * Sets the vertical layout offset of this signal.
86 void set_v_offset(int v_offset);
89 * Returns true if the signal has been selected by the user.
91 bool selected() const;
94 * Selects or deselects the signal.
96 void select(bool select = true);
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.
108 virtual void paint(QPainter &p, int y, int left, int right,
109 double scale, double offset) = 0;
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
117 * @param hover true if the label is being hovered over by the mouse.
119 virtual void paint_label(QPainter &p, int y, int right,
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
127 * @param right the x-coordinate of the right edge of the header
129 * @param point the point to test.
131 bool pt_in_label_rect(int y, int left, int right,
132 const QPoint &point);
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.
143 void paint_axis(QPainter &p, int y, int left, int right);
148 * Computes an caches the size of the label text.
150 void compute_text_size(QPainter &p);
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
158 * @return Returns the rectangle of the signal label.
160 QRectF get_label_rect(int y, int right);
163 const sr_probe *const _probe;
177 #endif // PULSEVIEW_PV_SIGNAL_H