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>
42 static const int LabelHitPadding;
43 static const int LabelHighlightRadius;
50 * Gets the name of this signal.
52 QString get_name() const;
55 * Sets the name of the signal.
57 void set_name(QString name);
60 * Get the colour of the signal.
62 QColor get_colour() const;
65 * Set the colour of the signal.
67 void set_colour(QColor colour);
70 * Gets the vertical layout offset of this signal.
72 int get_v_offset() const;
75 * Sets the vertical layout offset of this signal.
77 void set_v_offset(int v_offset);
80 * Returns true if the signal has been selected by the user.
82 bool selected() const;
85 * Selects or deselects the signal.
87 void select(bool select = true);
90 * Paints the signal with a QPainter
91 * @param p the QPainter to paint into.
92 * @param rect the rectangular area to draw the trace into.
93 * @param scale the scale in seconds per pixel.
94 * @param offset the time to show at the left hand edge of
95 * the view in seconds.
97 virtual void paint(QPainter &p, const QRect &rect, double scale,
102 * Paints the signal label into a QGLWidget.
103 * @param p the QPainter to paint into.
104 * @param rect the rectangular area to draw the label into.
105 * @param hover true if the label is being hovered over by the mouse.
107 virtual void paint_label(QPainter &p, const QRect &rect,
111 * Determines if a point is in the header label rect.
112 * @param rect the rectangular area to draw the label into.
113 * @param point the point to test.
115 bool pt_in_label_rect(const QRect &rect, const QPoint &point);
120 * Computes an caches the size of the label text.
122 void compute_text_size(QPainter &p);
125 * Computes the outline rectangle of a label.
126 * @param p the QPainter to lay out text with.
127 * @param rect The rectangle of the signal header.
128 * @return Returns the rectangle of the signal label.
130 QRectF get_label_rect(const QRect &rect);
134 * When painting into the rectangle, calculate the y
135 * offset of the zero point.
137 virtual int get_nominal_offset(const QRect &rect) const = 0;
152 #endif // PULSEVIEW_PV_SIGNAL_H