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
28 #include <unordered_map>
31 #include <QAbstractScrollArea>
35 #include <pv/data/signaldata.hpp>
37 #include "cursorpair.hpp"
38 #include "rowitemowner.hpp"
51 class View : public QAbstractScrollArea, public RowItemOwner {
56 SelectableItemHExtentsChanged = 1,
57 SelectableItemVExtentsChanged = 2
61 static const double MaxScale;
62 static const double MinScale;
64 static const int MaxScrollValue;
66 static const int ScaleUnits[3];
69 static const QColor CursorAreaColour;
71 static const QSizeF LabelPadding;
74 explicit View(Session &session, QWidget *parent = 0);
77 const Session& session() const;
80 * Returns the view of the owner.
82 virtual pv::view::View* view();
85 * Returns the view of the owner.
87 virtual const pv::view::View* view() const;
91 const Viewport* viewport() const;
94 * Returns the view time scale in seconds per pixel.
99 * Returns the time offset of the left edge of the view in
102 double offset() const;
103 int owner_visual_v_offset() const;
106 * Returns the SI prefix to apply to the graticule time markings.
108 unsigned int tick_prefix() const;
111 * Returns period of the graticule time markings.
113 double tick_period() const;
116 * Returns the number of nested parents that this row item owner has.
118 unsigned int depth() const;
120 void zoom(double steps);
121 void zoom(double steps, int offset);
125 void zoom_one_to_one();
128 * Sets the scale and offset.
129 * @param scale The new view scale in seconds per pixel.
130 * @param offset The view time offset in seconds.
132 void set_scale_offset(double scale, double offset);
134 std::set< std::shared_ptr<pv::data::SignalData> >
135 get_visible_data() const;
137 std::pair<double, double> get_time_extents() const;
140 * Returns true if cursors are displayed. false otherwise.
142 bool cursors_shown() const;
145 * Shows or hides the cursors.
147 void show_cursors(bool show = true);
150 * Moves the cursors to a convenient position in the view.
152 void centre_cursors();
155 * Returns a reference to the pair of cursors.
157 CursorPair& cursors();
160 * Returns a reference to the pair of cursors.
162 const CursorPair& cursors() const;
164 const QPoint& hover_point() const;
166 void update_viewport();
168 void restack_all_row_items();
171 void hover_point_changed();
173 void signals_moved();
175 void selection_changed();
177 void scale_offset_changed();
180 void get_scroll_layout(double &length, double &offset) const;
183 * Simultaneously sets the zoom and offset.
184 * @param scale The scale to set the view to in seconds per pixel. This
185 * value is clamped between MinScale and MaxScale.
186 * @param offset The offset of the left edge of the view in seconds.
188 void set_zoom(double scale, int offset);
191 * Find a tick spacing and number formatting that does not cause
192 * the values to collide.
194 void calculate_tick_spacing();
196 void update_scroll();
198 void update_layout();
201 * Satisifies RowItem functionality.
202 * @param p the QPainter to paint into.
203 * @param right the x-coordinate of the right edge of the header
205 * @param hover true if the label is being hovered over by the mouse.
207 void paint_label(QPainter &p, int right, bool hover);
210 * Computes the outline rectangle of a label.
211 * @param right the x-coordinate of the right edge of the header
213 * @return Returns the rectangle of the signal label.
215 QRectF label_rect(int right);
217 static bool add_channels_to_owner(
218 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
219 RowItemOwner *owner, int &offset,
220 std::unordered_map<std::shared_ptr<sigrok::Channel>,
221 std::shared_ptr<Signal> > &signal_map,
222 std::function<bool (std::shared_ptr<RowItem>)> filter_func =
223 std::function<bool (std::shared_ptr<RowItem>)>());
225 static void apply_offset(
226 std::shared_ptr<RowItem> row_item, int &offset);
229 bool eventFilter(QObject *object, QEvent *event);
231 bool viewportEvent(QEvent *e);
233 void resizeEvent(QResizeEvent *e);
236 void appearance_changed(bool label, bool content);
238 void extents_changed(bool horz, bool vert);
242 void h_scroll_value_changed(int value);
243 void v_scroll_value_changed(int value);
245 void signals_changed();
248 void marker_time_changed();
250 void on_signals_moved();
252 void process_sticky_events();
254 void on_hover_point_changed();
261 CursorHeader *cursorheader_;
264 /// The view time scale in seconds per pixel.
267 /// The view time offset in seconds.
271 bool updating_scroll_;
274 unsigned int tick_prefix_;
281 unsigned int sticky_events_;
282 QTimer lazy_event_handler_;
288 #endif // PULSEVIEW_PV_VIEW_VIEW_H