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>
32 #include <QWidgetAction>
36 #include <libsigrok/libsigrok.h>
38 #include "selectableitem.h"
48 class Signal : public SelectableItem
53 static const int LabelHitPadding;
55 static const QPen SignalAxisPen;
58 Signal(const sr_probe *const probe);
62 * Gets the name of this signal.
64 QString get_name() const;
67 * Sets the name of the signal.
69 void set_name(QString name);
72 * Get the colour of the signal.
74 QColor get_colour() const;
77 * Set the colour of the signal.
79 void set_colour(QColor colour);
82 * Gets the vertical layout offset of this signal.
84 int get_v_offset() const;
87 * Sets the vertical layout offset of this signal.
89 void set_v_offset(int v_offset);
92 * Paints the signal with a QPainter
93 * @param p the QPainter to paint into.
94 * @param y the y-coordinate to draw the signal at
95 * @param left the x-coordinate of the left edge of the signal
96 * @param right the x-coordinate of the right edge of the signal
97 * @param scale the scale in seconds per pixel.
98 * @param offset the time to show at the left hand edge of
99 * the view in seconds.
101 virtual void paint(QPainter &p, int y, int left, int right,
102 double scale, double offset) = 0;
105 * Paints the signal label into a QGLWidget.
106 * @param p the QPainter to paint into.
107 * @param y the y-coordinate of the signal.
108 * @param right the x-coordinate of the right edge of the header
110 * @param hover true if the label is being hovered over by the mouse.
112 virtual void paint_label(QPainter &p, int y, int right,
116 * Determines if a point is in the header label rect.
117 * @param y the y-coordinate of the signal.
118 * @param left the x-coordinate of the left edge of the header
120 * @param right the x-coordinate of the right edge of the header
122 * @param point the point to test.
124 bool pt_in_label_rect(int y, int left, int right,
125 const QPoint &point);
130 * Paints a zero axis across the viewport.
131 * @param p the QPainter to paint into.
132 * @param y the y-offset of the axis.
133 * @param left the x-coordinate of the left edge of the view.
134 * @param right the x-coordinate of the right edge of the view.
136 void paint_axis(QPainter &p, int y, int left, int right);
141 * Computes an caches the size of the label text.
143 void compute_text_size(QPainter &p);
146 * Computes the outline rectangle of a label.
147 * @param p the QPainter to lay out text with.
148 * @param y the y-coordinate of the signal.
149 * @param right the x-coordinate of the right edge of the header
151 * @return Returns the rectangle of the signal label.
153 QRectF get_label_rect(int y, int right);
156 void on_text_changed(const QString &text);
162 const sr_probe *const _probe;
170 QWidgetAction _name_action;
171 QComboBox _name_widget;
172 bool _updating_name_widget;
178 #endif // PULSEVIEW_PV_SIGNAL_H