2 * This file is part of the PulseView project.
4 * Copyright (C) 2013 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_TRACE_H
22 #define PULSEVIEW_PV_TRACE_H
31 #include "selectableitem.h"
39 class Trace : public SelectableItem
44 static const int LabelHitPadding;
47 Trace(SigSession &session, QString name);
51 * Gets the name of this signal.
53 QString get_name() const;
56 * Sets the name of the signal.
58 virtual void set_name(QString name);
61 * Get the colour of the signal.
63 QColor get_colour() const;
66 * Set the colour of the signal.
68 void set_colour(QColor colour);
71 * Gets the vertical layout offset of this signal.
73 int get_v_offset() const;
76 * Sets the vertical layout offset of this signal.
78 void set_v_offset(int v_offset);
81 * Returns true if the trace is visible and enabled.
83 virtual bool enabled() const = 0;
86 * Paints the trace with a QPainter
87 * @param p the QPainter to paint into.
88 * @param y the y-coordinate to draw the signal at
89 * @param left the x-coordinate of the left edge of the signal
90 * @param right the x-coordinate of the right edge of the signal
91 * @param scale the scale in seconds per pixel.
92 * @param offset the time to show at the left hand edge of
93 * the view in seconds.
95 virtual void paint(QPainter &p, int y, int left, int right,
96 double scale, double offset) = 0;
99 * Paints the signal label into a QGLWidget.
100 * @param p the QPainter to paint into.
101 * @param y the y-coordinate of the signal.
102 * @param right the x-coordinate of the right edge of the header
104 * @param hover true if the label is being hovered over by the mouse.
106 virtual void paint_label(QPainter &p, int y, int right,
110 * Determines if a point is in the header label rect.
111 * @param y the y-coordinate of the signal.
112 * @param left the x-coordinate of the left edge of the header
114 * @param right the x-coordinate of the right edge of the header
116 * @param point the point to test.
118 bool pt_in_label_rect(int y, int left, int right,
119 const QPoint &point);
124 * Computes an caches the size of the label text.
126 void compute_text_size(QPainter &p);
129 * Computes the outline rectangle of a label.
130 * @param p the QPainter to lay out text with.
131 * @param y the y-coordinate of the signal.
132 * @param right the x-coordinate of the right edge of the header
134 * @return Returns the rectangle of the signal label.
136 QRectF get_label_rect(int y, int right);
142 pv::SigSession &_session;
154 #endif // PULSEVIEW_PV_TRACEL_H