2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef PULSEVIEW_PV_VIEW_VIEW_HPP
22 #define PULSEVIEW_PV_VIEW_VIEW_HPP
29 #include <unordered_map>
32 #include <QAbstractScrollArea>
36 #include <pv/data/signaldata.hpp>
37 #include <pv/util.hpp>
39 #include "cursorpair.hpp"
41 #include "rowitemowner.hpp"
59 class View : public QAbstractScrollArea, public RowItemOwner {
64 RowItemHExtentsChanged = 1,
65 RowItemVExtentsChanged = 2
69 static const pv::util::Timestamp MaxScale;
70 static const pv::util::Timestamp MinScale;
72 static const int MaxScrollValue;
73 static const int MaxViewAutoUpdateRate;
75 static const int ScaleUnits[3];
78 explicit View(Session &session, QWidget *parent = 0);
81 const Session& session() const;
84 * Returns the view of the owner.
86 virtual pv::view::View* view();
89 * Returns the view of the owner.
91 virtual const pv::view::View* view() const;
95 const Viewport* viewport() const;
98 * Gets a list of time markers.
100 std::vector< std::shared_ptr<TimeItem> > time_items() const;
103 * Returns the view time scale in seconds per pixel.
105 double scale() const;
108 * Returns the time offset of the left edge of the view in
111 const pv::util::Timestamp& offset() const;
114 * Returns the vertical scroll offset.
116 int owner_visual_v_offset() const;
119 * Sets the visual v-offset.
121 void set_v_offset(int offset);
124 * Returns the SI prefix to apply to the graticule time markings.
126 pv::util::SIPrefix tick_prefix() const;
129 * Returns the number of fractional digits shown for the time markings.
131 unsigned int tick_precision() const;
134 * Returns period of the graticule time markings.
136 const pv::util::Timestamp& tick_period() const;
139 * Returns the unit of time currently used.
141 util::TimeUnit time_unit() const;
144 * Returns the number of nested parents that this row item owner has.
146 unsigned int depth() const;
148 void zoom(double steps);
149 void zoom(double steps, int offset);
151 void zoom_fit(bool gui_state);
153 void zoom_one_to_one();
156 * Sets the scale and offset.
157 * @param scale The new view scale in seconds per pixel.
158 * @param offset The view time offset in seconds.
160 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
162 std::set< std::shared_ptr<pv::data::SignalData> >
163 get_visible_data() const;
165 std::pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
168 * Enables or disables sticky scrolling, i.e. the view always shows
169 * the most recent samples when capturing data.
171 void enable_sticky_scrolling(bool state);
174 * Returns true if cursors are displayed. false otherwise.
176 bool cursors_shown() const;
179 * Shows or hides the cursors.
181 void show_cursors(bool show = true);
184 * Moves the cursors to a convenient position in the view.
186 void centre_cursors();
189 * Returns a reference to the pair of cursors.
191 std::shared_ptr<CursorPair> cursors() const;
194 * Adds a new flag at a specified time.
196 void add_flag(const pv::util::Timestamp& time);
199 * Removes a flag from the list.
201 void remove_flag(std::shared_ptr<Flag> flag);
204 * Gets the list of flags.
206 std::vector< std::shared_ptr<Flag> > flags() const;
208 const QPoint& hover_point() const;
210 void update_viewport();
212 void restack_all_row_items();
215 void hover_point_changed();
217 void selection_changed();
219 /// Emitted when the offset changed.
220 void offset_changed();
222 /// Emitted when the scale changed.
223 void scale_changed();
225 void sticky_scrolling_changed(bool state);
227 void always_zoom_to_fit_changed(bool state);
229 /// Emitted when the tick_prefix changed.
230 void tick_prefix_changed();
232 /// Emitted when the tick_precision changed.
233 void tick_precision_changed();
235 /// Emitted when the tick_period changed.
236 void tick_period_changed();
238 /// Emitted when the time_unit changed.
239 void time_unit_changed();
242 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
245 * Simultaneously sets the zoom and offset.
246 * @param scale The scale to set the view to in seconds per pixel. This
247 * value is clamped between MinScale and MaxScale.
248 * @param offset The offset of the left edge of the view in seconds.
250 void set_zoom(double scale, int offset);
253 * Find a tick spacing and number formatting that does not cause
254 * the values to collide.
256 void calculate_tick_spacing();
258 void update_scroll();
260 void update_layout();
263 * Satisifies RowItem functionality.
264 * @param p the QPainter to paint into.
265 * @param rect the rectangle of the header area.
266 * @param hover true if the label is being hovered over by the mouse.
268 void paint_label(QPainter &p, const QRect &rect, bool hover);
271 * Computes the outline rectangle of a label.
272 * @param rect the rectangle of the header area.
273 * @return Returns the rectangle of the signal label.
275 QRectF label_rect(const QRectF &rect);
277 RowItemOwner* find_prevalent_trace_group(
278 const std::shared_ptr<sigrok::ChannelGroup> &group,
279 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
280 std::shared_ptr<Signal> > &signal_map);
282 static std::vector< std::shared_ptr<Trace> >
283 extract_new_traces_for_channels(
284 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
285 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
286 std::shared_ptr<Signal> > &signal_map,
287 std::set< std::shared_ptr<Trace> > &add_list);
289 void determine_time_unit();
291 bool eventFilter(QObject *object, QEvent *event);
293 bool viewportEvent(QEvent *e);
295 void resizeEvent(QResizeEvent *e);
298 void row_item_appearance_changed(bool label, bool content);
299 void time_item_appearance_changed(bool label, bool content);
301 void extents_changed(bool horz, bool vert);
305 void h_scroll_value_changed(int value);
306 void v_scroll_value_changed();
308 void signals_changed();
309 void capture_state_updated(int state);
312 void perform_delayed_view_update();
314 void process_sticky_events();
316 void on_hover_point_changed();
319 * Sets the 'offset_' member and emits the 'offset_changed'
322 void set_offset(const pv::util::Timestamp& offset);
325 * Sets the 'scale_' member and emits the 'scale_changed'
328 void set_scale(double scale);
331 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
334 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
337 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
340 void set_tick_precision(unsigned tick_precision);
343 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
346 void set_tick_period(const pv::util::Timestamp& tick_period);
349 * Sets the 'time_unit' member and emits the 'time_unit_changed'
352 void set_time_unit(pv::util::TimeUnit time_unit);
361 /// The view time scale in seconds per pixel.
364 /// The view time offset in seconds.
365 pv::util::Timestamp offset_;
367 bool updating_scroll_;
368 bool sticky_scrolling_;
369 bool always_zoom_to_fit_;
370 QTimer delayed_view_updater_;
372 pv::util::Timestamp tick_period_;
373 pv::util::SIPrefix tick_prefix_;
374 unsigned int tick_precision_;
375 util::TimeUnit time_unit_;
378 std::shared_ptr<CursorPair> cursors_;
380 std::list< std::shared_ptr<Flag> > flags_;
381 char next_flag_text_;
385 unsigned int sticky_events_;
386 QTimer lazy_event_handler_;
392 #endif // PULSEVIEW_PV_VIEW_VIEW_HPP