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
68 * Allowed values for the multi-segment display mode.
70 * Note: Consider @ref View::set_segment_display_mode when updating the list.
72 enum SegmentDisplayMode {
73 ShowLastSegmentOnly = 1,
74 ShowSingleSegmentOnly,
76 ShowAccumulatedIntensity
80 static const QPen AxisPen;
81 static const int LabelHitPadding;
83 static const QColor BrightGrayBGColour;
84 static const QColor DarkGrayBGColour;
87 Trace(shared_ptr<data::SignalBase> channel);
91 * Returns the underlying SignalBase instance.
93 shared_ptr<data::SignalBase> base() const;
96 * Sets the name of the signal.
98 virtual void set_name(QString name);
101 * Set the colour of the signal.
103 virtual void set_colour(QColor colour);
106 * Configures the segment display mode to use.
108 virtual void set_segment_display_mode(SegmentDisplayMode mode);
111 * Paints the signal label.
112 * @param p the QPainter to paint into.
113 * @param rect the rectangle of the header area.
114 * @param hover true if the label is being hovered over by the mouse.
116 virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
118 virtual QMenu* create_context_menu(QWidget *parent);
120 pv::widgets::Popup* create_popup(QWidget *parent);
123 * Computes the outline rectangle of a label.
124 * @param rect the rectangle of the header area.
125 * @return Returns the rectangle of the signal label.
127 QRectF label_rect(const QRectF &rect) const;
129 void set_current_segment(const int segment);
131 int get_current_segment() const;
135 * Paints the background layer of the signal with a QPainter.
136 * @param p The QPainter to paint into.
137 * @param pp The painting parameters object to paint with.
139 virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
142 * Paints a zero axis across the viewport.
143 * @param p the QPainter to paint into.
144 * @param pp the painting parameters object to paint with.
145 * @param y the y-offset of the axis.
147 void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
149 void add_colour_option(QWidget *parent, QFormLayout *form);
151 void create_popup_form();
153 virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
156 virtual void on_name_changed(const QString &text);
158 virtual void on_colour_changed(const QColor &colour);
160 void on_popup_closed();
163 void on_nameedit_changed(const QString &name);
165 void on_colouredit_changed(const QColor &colour);
168 shared_ptr<data::SignalBase> base_;
171 SegmentDisplayMode segment_display_mode_;
173 /// The ID of the currently displayed segment
174 int current_segment_;
177 pv::widgets::Popup *popup_;
178 QFormLayout *popup_form_;
185 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP