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_H
22 #define PULSEVIEW_PV_VIEW_VIEW_H
29 #include <unordered_map>
32 #include <QAbstractScrollArea>
36 #include <pv/data/signaldata.hpp>
38 #include "cursorpair.hpp"
40 #include "rowitemowner.hpp"
53 class View : public QAbstractScrollArea, public RowItemOwner {
58 RowItemHExtentsChanged = 1,
59 RowItemVExtentsChanged = 2
63 static const double MaxScale;
64 static const double MinScale;
66 static const int MaxScrollValue;
68 static const int ScaleUnits[3];
71 explicit View(Session &session, QWidget *parent = 0);
74 const Session& session() const;
77 * Returns the view of the owner.
79 virtual pv::view::View* view();
82 * Returns the view of the owner.
84 virtual const pv::view::View* view() const;
88 const Viewport* viewport() const;
91 * Gets a list of time markers.
93 std::vector< std::shared_ptr<TimeItem> > time_items() const;
96 * Returns the view time scale in seconds per pixel.
101 * Returns the time offset of the left edge of the view in
104 double offset() const;
107 * Returns the vertical scroll offset.
109 int owner_visual_v_offset() const;
112 * Returns the SI prefix to apply to the graticule time markings.
114 unsigned int tick_prefix() const;
117 * Returns period of the graticule time markings.
119 double tick_period() const;
122 * Returns the number of nested parents that this row item owner has.
124 unsigned int depth() const;
126 void zoom(double steps);
127 void zoom(double steps, int offset);
131 void zoom_one_to_one();
134 * Sets the scale and offset.
135 * @param scale The new view scale in seconds per pixel.
136 * @param offset The view time offset in seconds.
138 void set_scale_offset(double scale, double offset);
140 std::set< std::shared_ptr<pv::data::SignalData> >
141 get_visible_data() const;
143 std::pair<double, double> get_time_extents() const;
146 * Returns true if cursors are displayed. false otherwise.
148 bool cursors_shown() const;
151 * Shows or hides the cursors.
153 void show_cursors(bool show = true);
156 * Moves the cursors to a convenient position in the view.
158 void centre_cursors();
161 * Returns a reference to the pair of cursors.
163 std::shared_ptr<CursorPair> cursors() const;
166 * Adds a new flag at a specified time.
168 void add_flag(double time);
171 * Removes a flag from the list.
173 void remove_flag(std::shared_ptr<Flag> flag);
176 * Gets the list of flags.
178 std::vector< std::shared_ptr<Flag> > flags() const;
180 const QPoint& hover_point() const;
182 void update_viewport();
184 void restack_all_row_items();
187 void hover_point_changed();
189 void selection_changed();
191 void scale_offset_changed();
194 void get_scroll_layout(double &length, double &offset) const;
197 * Simultaneously sets the zoom and offset.
198 * @param scale The scale to set the view to in seconds per pixel. This
199 * value is clamped between MinScale and MaxScale.
200 * @param offset The offset of the left edge of the view in seconds.
202 void set_zoom(double scale, int offset);
205 * Find a tick spacing and number formatting that does not cause
206 * the values to collide.
208 void calculate_tick_spacing();
210 void update_scroll();
212 void update_layout();
215 * Satisifies RowItem functionality.
216 * @param p the QPainter to paint into.
217 * @param rect the rectangle of the header area.
218 * @param hover true if the label is being hovered over by the mouse.
220 void paint_label(QPainter &p, const QRect &rect, bool hover);
223 * Computes the outline rectangle of a label.
224 * @param rect the rectangle of the header area.
225 * @return Returns the rectangle of the signal label.
227 QRectF label_rect(const QRectF &rect);
229 static bool add_channels_to_owner(
230 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
231 RowItemOwner *owner, int &offset,
232 std::unordered_map<std::shared_ptr<sigrok::Channel>,
233 std::shared_ptr<Signal> > &signal_map,
234 std::function<bool (std::shared_ptr<RowItem>)> filter_func =
235 std::function<bool (std::shared_ptr<RowItem>)>());
237 static void apply_offset(
238 std::shared_ptr<RowItem> row_item, int &offset);
241 bool eventFilter(QObject *object, QEvent *event);
243 bool viewportEvent(QEvent *e);
245 void resizeEvent(QResizeEvent *e);
248 void row_item_appearance_changed(bool label, bool content);
249 void time_item_appearance_changed(bool label, bool content);
251 void extents_changed(bool horz, bool vert);
255 void h_scroll_value_changed(int value);
256 void v_scroll_value_changed();
258 void signals_changed();
261 void process_sticky_events();
263 void on_hover_point_changed();
272 /// The view time scale in seconds per pixel.
275 /// The view time offset in seconds.
278 bool updating_scroll_;
281 unsigned int tick_prefix_;
284 std::shared_ptr<CursorPair> cursors_;
286 std::list< std::shared_ptr<Flag> > flags_;
287 char next_flag_text_;
291 unsigned int sticky_events_;
292 QTimer lazy_event_handler_;
298 #endif // PULSEVIEW_PV_VIEW_VIEW_H