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_TRACE_TRACE_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACE_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;
94 static const QColor ErrorBgColor;
97 Trace(shared_ptr<data::SignalBase> signal);
102 * Returns the underlying SignalBase instance.
104 shared_ptr<data::SignalBase> base() const;
107 * Returns true if the item may be selected.
109 virtual bool is_selectable(QPoint pos) const;
112 * Returns true if the item may be dragged/moved.
114 virtual bool is_draggable(QPoint pos) const;
117 * Configures the segment display mode to use.
119 virtual void set_segment_display_mode(SegmentDisplayMode mode);
121 virtual void on_setting_changed(const QString &key, const QVariant &value);
124 * Paints the signal label.
125 * @param p the QPainter to paint into.
126 * @param rect the rectangle of the header area.
127 * @param hover true if the label is being hovered over by the mouse.
129 virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
132 * Paints the signal's current error message text.
133 * @param p the QPainter to paint into.
134 * @param pp The painting parameters object to paint with.
136 virtual void paint_error(QPainter &p, const ViewItemPaintParams &pp);
138 virtual QMenu* create_header_context_menu(QWidget *parent);
140 virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
142 pv::widgets::Popup* create_popup(QWidget *parent);
145 * Computes the outline rectangle of a label.
146 * @param rect the rectangle of the header area.
147 * @return Returns the rectangle of the signal label.
149 QRectF label_rect(const QRectF &rect) const;
152 * Computes the outline rectangle of the viewport hit-box.
153 * @param pp The painting parameters object to paint with.
154 * @return Returns the rectangle of the hit-box.
155 * @remarks The default implementation returns an empty hit-box.
157 virtual QRectF hit_box_rect(const ViewItemPaintParams &pp) const;
159 void set_current_segment(const int segment);
161 int get_current_segment() const;
163 virtual void hover_point_changed(const QPoint &hp);
167 * Paints the background layer of the signal with a QPainter.
168 * @param p The QPainter to paint into.
169 * @param pp The painting parameters object to paint with.
171 virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
174 * Paints a zero axis across the viewport.
175 * @param p the QPainter to paint into.
176 * @param pp the painting parameters object to paint with.
177 * @param y the y-offset of the axis.
179 void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
182 * Draw a hover marker under the cursor position.
183 * @param p The painter to draw into.
185 void paint_hover_marker(QPainter &p);
187 void add_color_option(QWidget *parent, QFormLayout *form);
189 void create_popup_form();
191 virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
194 virtual void on_name_changed(const QString &text);
195 virtual void on_color_changed(const QColor &color);
196 virtual void on_error_message_changed(const QString &msg);
198 void on_popup_closed();
201 void on_nameedit_changed(const QString &name);
203 void on_coloredit_changed(const QColor &color);
205 void on_create_marker_here() const;
208 shared_ptr<data::SignalBase> base_;
211 SegmentDisplayMode segment_display_mode_;
212 bool show_hover_marker_;
214 uint32_t context_menu_x_pos_;
216 /// The ID of the currently displayed segment
217 int current_segment_;
220 pv::widgets::Popup *popup_;
221 QFormLayout *popup_form_;
228 #endif // PULSEVIEW_PV_VIEWS_TRACE_TRACE_HPP