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 these locations when updating the list:
72 * @ref View::set_segment_display_mode
73 * @ref AnalogSignal::get_analog_segment_to_paint
74 * @ref AnalogSignal::get_logic_segment_to_paint
75 * @ref LogicSignal::get_logic_segment_to_paint
77 enum SegmentDisplayMode {
78 ShowLastSegmentOnly = 1,
79 ShowLastCompleteSegmentOnly,
80 ShowSingleSegmentOnly,
82 ShowAccumulatedIntensity
86 static const QPen AxisPen;
87 static const int LabelHitPadding;
89 static const QColor BrightGrayBGColour;
90 static const QColor DarkGrayBGColour;
93 Trace(shared_ptr<data::SignalBase> channel);
97 * Returns the underlying SignalBase instance.
99 shared_ptr<data::SignalBase> base() const;
102 * Sets the name of the signal.
104 virtual void set_name(QString name);
107 * Set the colour of the signal.
109 virtual void set_colour(QColor colour);
112 * Configures the segment display mode to use.
114 virtual void set_segment_display_mode(SegmentDisplayMode mode);
117 * Paints the signal label.
118 * @param p the QPainter to paint into.
119 * @param rect the rectangle of the header area.
120 * @param hover true if the label is being hovered over by the mouse.
122 virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
124 virtual QMenu* create_context_menu(QWidget *parent);
126 pv::widgets::Popup* create_popup(QWidget *parent);
129 * Computes the outline rectangle of a label.
130 * @param rect the rectangle of the header area.
131 * @return Returns the rectangle of the signal label.
133 QRectF label_rect(const QRectF &rect) const;
135 void set_current_segment(const int segment);
137 int get_current_segment() const;
141 * Paints the background layer of the signal with a QPainter.
142 * @param p The QPainter to paint into.
143 * @param pp The painting parameters object to paint with.
145 virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
148 * Paints a zero axis across the viewport.
149 * @param p the QPainter to paint into.
150 * @param pp the painting parameters object to paint with.
151 * @param y the y-offset of the axis.
153 void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
155 void add_colour_option(QWidget *parent, QFormLayout *form);
157 void create_popup_form();
159 virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
162 virtual void on_name_changed(const QString &text);
164 virtual void on_colour_changed(const QColor &colour);
166 void on_popup_closed();
169 void on_nameedit_changed(const QString &name);
171 void on_colouredit_changed(const QColor &colour);
174 shared_ptr<data::SignalBase> base_;
177 SegmentDisplayMode segment_display_mode_;
179 /// The ID of the currently displayed segment
180 int current_segment_;
183 pv::widgets::Popup *popup_;
184 QFormLayout *popup_form_;
191 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP