pv/view/view.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #ifndef PULSEVIEW_PV_VIEW_VIEW_H
  22 #define PULSEVIEW_PV_VIEW_VIEW_H
  23
  24 #include <stdint.h>
  25
  26 #include <memory>
  27 #include <set>
  28 #include <vector>
  29
  30 #include <QAbstractScrollArea>
  31 #include <QSizeF>
  32 #include <QTimer>
  33
  34 #include <pv/data/signaldata.h>
  35
  36 #include "cursorpair.h"
  37 #include "rowitemowner.h"
  38
  39 namespace pv {
  40
  41 class SigSession;
  42
  43 namespace view {
  44
  45 class CursorHeader;
  46 class Header;
  47 class Ruler;
  48 class Viewport;
  49
  50 class View : public QAbstractScrollArea, public RowItemOwner {
  51         Q_OBJECT
  52
  53 private:
  54         enum StickyEvents {
  55                 SelectableItemHExtentsChanged = 1,
  56                 SelectableItemVExtentsChanged = 2
  57         };
  58
  59 private:
  60         static const double MaxScale;
  61         static const double MinScale;
  62
  63         static const int MaxScrollValue;
  64
  65 public:
  66         static const QColor CursorAreaColour;
  67
  68         static const QSizeF LabelPadding;
  69
  70 public:
  71         explicit View(SigSession &session, QWidget *parent = 0);
  72
  73         SigSession& session();
  74         const SigSession& session() const;
  75
  76         /**
  77          * Returns the view of the owner.
  78          */
  79         virtual pv::view::View* view();
  80
  81         /**
  82          * Returns the view of the owner.
  83          */
  84         virtual const pv::view::View* view() const;
  85
  86         Viewport* viewport();
  87
  88         const Viewport* viewport() const;
  89
  90         /**
  91          * Returns the view time scale in seconds per pixel.
  92          */
  93         double scale() const;
  94
  95         /**
  96          * Returns the time offset of the left edge of the view in
  97          * seconds.
  98          */
  99         double offset() const;
 100         int owner_visual_v_offset() const;
 101
 102         /**
 103          * Returns the number of nested parents that this row item owner has.
 104          */
 105         unsigned int depth() const;
 106
 107         void zoom(double steps);
 108         void zoom(double steps, int offset);
 109
 110         void zoom_fit();
 111
 112         void zoom_one_to_one();
 113
 114         /**
 115          * Sets the scale and offset.
 116          * @param scale The new view scale in seconds per pixel.
 117          * @param offset The view time offset in seconds.
 118          */
 119         void set_scale_offset(double scale, double offset);
 120
 121         std::set< std::shared_ptr<pv::data::SignalData> >
 122                 get_visible_data() const;
 123
 124         std::pair<double, double> get_time_extents() const;
 125
 126         /**
 127          * Returns true if cursors are displayed. false otherwise.
 128          */
 129         bool cursors_shown() const;
 130
 131         /**
 132          * Shows or hides the cursors.
 133          */
 134         void show_cursors(bool show = true);
 135
 136         /**
 137          * Moves the cursors to a convenient position in the view.
 138          */
 139         void centre_cursors();
 140
 141         /**
 142          * Returns a reference to the pair of cursors.
 143          */
 144         CursorPair& cursors();
 145
 146         /**
 147          * Returns a reference to the pair of cursors.
 148          */
 149         const CursorPair& cursors() const;
 150
 151         const QPoint& hover_point() const;
 152
 153         void update_viewport();
 154
 155         void restack_all_row_items();
 156
 157 Q_SIGNALS:
 158         void hover_point_changed();
 159
 160         void signals_moved();
 161
 162         void selection_changed();
 163
 164         void scale_offset_changed();
 165
 166 private:
 167         void get_scroll_layout(double &length, double &offset) const;
 168
 169         /**
 170          * Simultaneously sets the zoom and offset.
 171          * @param scale The scale to set the view to in seconds per pixel. This
 172          * value is clamped between MinScale and MaxScale.
 173          * @param offset The offset of the left edge of the view in seconds.
 174          */
 175         void set_zoom(double scale, int offset);
 176
 177         void update_scroll();
 178
 179         void update_layout();
 180
 181         /**
 182          * Satisifies RowItem functionality.
 183          * @param p the QPainter to paint into.
 184          * @param right the x-coordinate of the right edge of the header
 185          *      area.
 186          * @param hover true if the label is being hovered over by the mouse.
 187          */
 188         void paint_label(QPainter &p, int right, bool hover);
 189
 190         /**
 191          * Computes the outline rectangle of a label.
 192          * @param right the x-coordinate of the right edge of the header
 193          *      area.
 194          * @return Returns the rectangle of the signal label.
 195          */
 196         QRectF label_rect(int right);
 197
 198 private:
 199         bool eventFilter(QObject *object, QEvent *event);
 200
 201         bool viewportEvent(QEvent *e);
 202
 203         void resizeEvent(QResizeEvent *e);
 204
 205 public:
 206         void appearance_changed(bool label, bool content);
 207
 208         void extents_changed(bool horz, bool vert);
 209
 210 private Q_SLOTS:
 211
 212         void h_scroll_value_changed(int value);
 213         void v_scroll_value_changed(int value);
 214
 215         void signals_changed();
 216         void data_updated();
 217
 218         void marker_time_changed();
 219
 220         void on_signals_moved();
 221
 222         void process_sticky_events();
 223
 224         void on_hover_point_changed();
 225
 226 private:
 227         SigSession &_session;
 228
 229         Viewport *_viewport;
 230         Ruler *_ruler;
 231         CursorHeader *_cursorheader;
 232         Header *_header;
 233
 234         /// The view time scale in seconds per pixel.
 235         double _scale;
 236
 237         /// The view time offset in seconds.
 238         double _offset;
 239
 240         int _v_offset;
 241         bool _updating_scroll;
 242
 243         bool _show_cursors;
 244         CursorPair _cursors;
 245
 246         QPoint _hover_point;
 247
 248         unsigned int _sticky_events;
 249         QTimer _lazy_event_handler;
 250 };
 251
 252 } // namespace view
 253 } // namespace pv
 254
 255 #endif // PULSEVIEW_PV_VIEW_VIEW_H