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>
45 static const int LabelHitPadding;
46 static const int LabelHighlightRadius;
48 static const QPen SignalAxisPen;
55 * Gets the name of this signal.
57 QString get_name() const;
60 * Sets the name of the signal.
62 void set_name(QString name);
65 * Get the colour of the signal.
67 QColor get_colour() const;
70 * Set the colour of the signal.
72 void set_colour(QColor colour);
75 * Gets the vertical layout offset of this signal.
77 int get_v_offset() const;
80 * Sets the vertical layout offset of this signal.
82 void set_v_offset(int v_offset);
85 * Returns true if the signal has been selected by the user.
87 bool selected() const;
90 * Selects or deselects the signal.
92 void select(bool select = true);
95 * Paints the signal with a QPainter
96 * @param p the QPainter to paint into.
97 * @param y the y-coordinate to draw the signal at
98 * @param left the x-coordinate of the left edge of the signal
99 * @param right the x-coordinate of the right edge of the signal
100 * @param scale the scale in seconds per pixel.
101 * @param offset the time to show at the left hand edge of
102 * the view in seconds.
104 virtual void paint(QPainter &p, int y, int left, int right,
105 double scale, double offset) = 0;
108 * Paints the signal label into a QGLWidget.
109 * @param p the QPainter to paint into.
110 * @param y the y-coordinate of the signal.
111 * @param right the x-coordinate of the right edge of the header
113 * @param hover true if the label is being hovered over by the mouse.
115 virtual void paint_label(QPainter &p, int y, int right,
119 * Determines if a point is in the header label rect.
120 * @param y the y-coordinate of the signal.
121 * @param left the x-coordinate of the left edge of the header
123 * @param right the x-coordinate of the right edge of the header
125 * @param point the point to test.
127 bool pt_in_label_rect(int y, int left, int right,
128 const QPoint &point);
133 * Paints a zero axis across the viewport.
134 * @param p the QPainter to paint into.
135 * @param y the y-offset of the axis.
136 * @param left the x-coordinate of the left edge of the view.
137 * @param right the x-coordinate of the right edge of the view.
139 void paint_axis(QPainter &p, int y, int left, int right);
144 * Computes an caches the size of the label text.
146 void compute_text_size(QPainter &p);
149 * Computes the outline rectangle of a label.
150 * @param p the QPainter to lay out text with.
151 * @param y the y-coordinate of the signal.
152 * @param right the x-coordinate of the right edge of the header
154 * @return Returns the rectangle of the signal label.
156 QRectF get_label_rect(int y, int right);
171 #endif // PULSEVIEW_PV_SIGNAL_H