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>
40 static const int LabelHitPadding;
47 * Gets the name of this signal.
49 QString get_name() const;
52 * Sets the name of the signal.
54 void set_name(QString name);
57 * Get the colour of the signal.
59 QColor get_colour() const;
62 * Set the colour of the signal.
64 void set_colour(QColor colour);
67 * Paints the signal with a QPainter
68 * @param p the QPainter to paint into.
69 * @param rect the rectangular area to draw the trace into.
70 * @param scale the scale in seconds per pixel.
71 * @param offset the time to show at the left hand edge of
72 * the view in seconds.
74 virtual void paint(QPainter &p, const QRect &rect, double scale,
79 * Paints the signal label into a QGLWidget.
80 * @param p the QPainter to paint into.
81 * @param rect the rectangular area to draw the label into.
82 * @param hover true if the label is being hovered over by the mouse.
84 virtual void paint_label(QPainter &p, const QRect &rect,
88 * Determines if a point is in the header label rect.
89 * @param rect the rectangular area to draw the label into.
90 * @param point the point to test.
92 bool pt_in_label_rect(const QRect &rect, const QPoint &point);
97 * Computes an caches the size of the label text.
99 void compute_text_size(QPainter &p);
102 * Computes the outline rectangle of a label.
103 * @param p the QPainter to lay out text with.
104 * @param rect The rectangle of the signal header.
105 * @return Returns the rectangle of the signal label.
107 QRectF get_label_rect(const QRect &rect);
111 * When painting into the rectangle, calculate the y
112 * offset of the zero point.
114 virtual int get_nominal_offset(const QRect &rect) const = 0;
125 #endif // PULSEVIEW_PV_SIGNAL_H