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/globalsettings.hpp>
34 #include "pv/data/signalbase.hpp"
36 using std::shared_ptr;
54 * The Trace class represents a @ref TraceTreeItem which occupies some vertical
55 * space on the canvas and spans across its entire width, essentially showing
56 * a time series of values, events, objects or similar. While easily confused
57 * with @ref Signal, the difference is that Trace may represent anything that
58 * can be drawn, not just numeric values. One example is a @ref DecodeTrace.
60 * For this reason, Trace is more generic and contains properties and helpers
61 * that benefit any kind of time series items.
63 class Trace : public TraceTreeItem, public GlobalSettingsInterface
69 * Allowed values for the multi-segment display mode.
71 * Note: Consider these locations when updating the list:
73 * @ref View::set_segment_display_mode
74 * @ref View::on_segment_changed
75 * @ref AnalogSignal::get_analog_segment_to_paint
76 * @ref AnalogSignal::get_logic_segment_to_paint
77 * @ref LogicSignal::get_logic_segment_to_paint
80 enum SegmentDisplayMode {
81 ShowLastSegmentOnly = 1,
82 ShowLastCompleteSegmentOnly,
83 ShowSingleSegmentOnly,
85 ShowAccumulatedIntensity
89 static const QPen AxisPen;
90 static const int LabelHitPadding;
92 static const QColor BrightGrayBGColor;
93 static const QColor DarkGrayBGColor;
96 Trace(shared_ptr<data::SignalBase> channel);
101 * Returns the underlying SignalBase instance.
103 shared_ptr<data::SignalBase> base() const;
106 * Configures the segment display mode to use.
108 virtual void set_segment_display_mode(SegmentDisplayMode mode);
110 virtual void on_setting_changed(const QString &key, const QVariant &value);
113 * Paints the signal label.
114 * @param p the QPainter to paint into.
115 * @param rect the rectangle of the header area.
116 * @param hover true if the label is being hovered over by the mouse.
118 virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
120 virtual QMenu* create_header_context_menu(QWidget *parent);
122 pv::widgets::Popup* create_popup(QWidget *parent);
125 * Computes the outline rectangle of a label.
126 * @param rect the rectangle of the header area.
127 * @return Returns the rectangle of the signal label.
129 QRectF label_rect(const QRectF &rect) const;
132 * Computes the outline rectangle of the viewport hit-box.
133 * @param rect the rectangle of the viewport area.
134 * @return Returns the rectangle of the hit-box.
135 * @remarks The default implementation returns an empty hit-box.
137 virtual QRectF hit_box_rect(const ViewItemPaintParams &pp) const;
139 void set_current_segment(const int segment);
141 int get_current_segment() const;
143 virtual void hover_point_changed(const QPoint &hp);
147 * Paints the background layer of the signal with a QPainter.
148 * @param p The QPainter to paint into.
149 * @param pp The painting parameters object to paint with.
151 virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
154 * Paints a zero axis across the viewport.
155 * @param p the QPainter to paint into.
156 * @param pp the painting parameters object to paint with.
157 * @param y the y-offset of the axis.
159 void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
162 * Draw a hover marker under the cursor position.
163 * @param p The painter to draw into.
165 void paint_hover_marker(QPainter &p);
167 void add_color_option(QWidget *parent, QFormLayout *form);
169 void create_popup_form();
171 virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
174 virtual void on_name_changed(const QString &text);
176 virtual void on_color_changed(const QColor &color);
178 void on_popup_closed();
181 void on_nameedit_changed(const QString &name);
183 void on_coloredit_changed(const QColor &color);
186 shared_ptr<data::SignalBase> base_;
189 SegmentDisplayMode segment_display_mode_;
190 bool show_hover_marker_;
192 /// The ID of the currently displayed segment
193 int current_segment_;
196 pv::widgets::Popup *popup_;
197 QFormLayout *popup_form_;
204 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP