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, see <http://www.gnu.org/licenses/>.
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP
31 #include "tracetreeitem.hpp"
33 #include "pv/data/signalbase.hpp"
35 using std::shared_ptr;
53 * The Trace class represents a @ref TraceTreeItem which occupies some vertical
54 * space on the canvas and spans across its entire width, essentially showing
55 * a time series of values, events, objects or similar. While easily confused
56 * with @ref Signal, the difference is that Trace may represent anything that
57 * can be drawn, not just numeric values. One example is a @ref DecodeTrace.
59 * For this reason, Trace is more generic and contains properties and helpers
60 * that benefit any kind of time series items.
62 class Trace : public TraceTreeItem
67 static const QPen AxisPen;
68 static const int LabelHitPadding;
70 static const QColor BrightGrayBGColour;
71 static const QColor DarkGrayBGColour;
74 Trace(shared_ptr<data::SignalBase> channel);
78 * Returns the underlying SignalBase instance.
80 shared_ptr<data::SignalBase> base() const;
83 * Sets the name of the signal.
85 virtual void set_name(QString name);
88 * Set the colour of the signal.
90 virtual void set_colour(QColor colour);
93 * Paints the signal label.
94 * @param p the QPainter to paint into.
95 * @param rect the rectangle of the header area.
96 * @param hover true if the label is being hovered over by the mouse.
98 virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
100 virtual QMenu* create_context_menu(QWidget *parent);
102 pv::widgets::Popup* create_popup(QWidget *parent);
105 * Computes the outline rectangle of a label.
106 * @param rect the rectangle of the header area.
107 * @return Returns the rectangle of the signal label.
109 QRectF label_rect(const QRectF &rect) const;
113 * Paints the background layer of the signal with a QPainter.
114 * @param p The QPainter to paint into.
115 * @param pp The painting parameters object to paint with.
117 virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
120 * Paints a zero axis across the viewport.
121 * @param p the QPainter to paint into.
122 * @param pp the painting parameters object to paint with.
123 * @param y the y-offset of the axis.
125 void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
127 void add_colour_option(QWidget *parent, QFormLayout *form);
129 void create_popup_form();
131 virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
134 virtual void on_name_changed(const QString &text);
136 virtual void on_colour_changed(const QColor &colour);
138 void on_popup_closed();
141 void on_nameedit_changed(const QString &name);
143 void on_colouredit_changed(const QColor &colour);
146 shared_ptr<data::SignalBase> base_;
150 pv::widgets::Popup *popup_;
151 QFormLayout *popup_form_;
158 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP