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>
38 #include "cursorpair.hpp"
40 #include "rowitemowner.hpp"
58 class View : public QAbstractScrollArea, public RowItemOwner {
63 RowItemHExtentsChanged = 1,
64 RowItemVExtentsChanged = 2
68 static const double MaxScale;
69 static const double MinScale;
71 static const int MaxScrollValue;
73 static const int ScaleUnits[3];
76 explicit View(Session &session, QWidget *parent = 0);
79 const Session& session() const;
82 * Returns the view of the owner.
84 virtual pv::view::View* view();
87 * Returns the view of the owner.
89 virtual const pv::view::View* view() const;
93 const Viewport* viewport() const;
96 * Gets a list of time markers.
98 std::vector< std::shared_ptr<TimeItem> > time_items() const;
101 * Returns the view time scale in seconds per pixel.
103 double scale() const;
106 * Returns the time offset of the left edge of the view in
109 double offset() const;
112 * Returns the vertical scroll offset.
114 int owner_visual_v_offset() const;
117 * Sets the visual v-offset.
119 void set_v_offset(int offset);
122 * Returns the SI prefix to apply to the graticule time markings.
124 unsigned int tick_prefix() const;
127 * Returns period of the graticule time markings.
129 double tick_period() const;
132 * Returns the number of nested parents that this row item owner has.
134 unsigned int depth() const;
136 void zoom(double steps);
137 void zoom(double steps, int offset);
141 void zoom_one_to_one();
144 * Sets the scale and offset.
145 * @param scale The new view scale in seconds per pixel.
146 * @param offset The view time offset in seconds.
148 void set_scale_offset(double scale, double offset);
150 std::set< std::shared_ptr<pv::data::SignalData> >
151 get_visible_data() const;
153 std::pair<double, double> get_time_extents() const;
156 * Returns true if cursors are displayed. false otherwise.
158 bool cursors_shown() const;
161 * Shows or hides the cursors.
163 void show_cursors(bool show = true);
166 * Moves the cursors to a convenient position in the view.
168 void centre_cursors();
171 * Returns a reference to the pair of cursors.
173 std::shared_ptr<CursorPair> cursors() const;
176 * Adds a new flag at a specified time.
178 void add_flag(double time);
181 * Removes a flag from the list.
183 void remove_flag(std::shared_ptr<Flag> flag);
186 * Gets the list of flags.
188 std::vector< std::shared_ptr<Flag> > flags() const;
190 const QPoint& hover_point() const;
192 void update_viewport();
194 void restack_all_row_items();
197 void hover_point_changed();
199 void selection_changed();
201 void scale_offset_changed();
204 void get_scroll_layout(double &length, double &offset) const;
207 * Simultaneously sets the zoom and offset.
208 * @param scale The scale to set the view to in seconds per pixel. This
209 * value is clamped between MinScale and MaxScale.
210 * @param offset The offset of the left edge of the view in seconds.
212 void set_zoom(double scale, int offset);
215 * Find a tick spacing and number formatting that does not cause
216 * the values to collide.
218 void calculate_tick_spacing();
220 void update_scroll();
222 void update_layout();
225 * Satisifies RowItem functionality.
226 * @param p the QPainter to paint into.
227 * @param rect the rectangle of the header area.
228 * @param hover true if the label is being hovered over by the mouse.
230 void paint_label(QPainter &p, const QRect &rect, bool hover);
233 * Computes the outline rectangle of a label.
234 * @param rect the rectangle of the header area.
235 * @return Returns the rectangle of the signal label.
237 QRectF label_rect(const QRectF &rect);
239 RowItemOwner* find_prevalent_trace_group(
240 const std::shared_ptr<sigrok::ChannelGroup> &group,
241 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
242 std::shared_ptr<Signal> > &signal_map);
244 static std::vector< std::shared_ptr<Trace> >
245 extract_new_traces_for_channels(
246 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
247 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
248 std::shared_ptr<Signal> > &signal_map,
249 std::set< std::shared_ptr<Trace> > &add_list);
252 bool eventFilter(QObject *object, QEvent *event);
254 bool viewportEvent(QEvent *e);
256 void resizeEvent(QResizeEvent *e);
259 void row_item_appearance_changed(bool label, bool content);
260 void time_item_appearance_changed(bool label, bool content);
262 void extents_changed(bool horz, bool vert);
266 void h_scroll_value_changed(int value);
267 void v_scroll_value_changed();
269 void signals_changed();
272 void process_sticky_events();
274 void on_hover_point_changed();
283 /// The view time scale in seconds per pixel.
286 /// The view time offset in seconds.
289 bool updating_scroll_;
292 unsigned int tick_prefix_;
295 std::shared_ptr<CursorPair> cursors_;
297 std::list< std::shared_ptr<Flag> > flags_;
298 char next_flag_text_;
302 unsigned int sticky_events_;
303 QTimer lazy_event_handler_;
309 #endif // PULSEVIEW_PV_VIEW_VIEW_HPP