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_v_offset() const;
 101
 102         void zoom(double steps);
 103         void zoom(double steps, int offset);
 104
 105         void zoom_fit();
 106
 107         void zoom_one_to_one();
 108
 109         /**
 110          * Sets the scale and offset.
 111          * @param scale The new view scale in seconds per pixel.
 112          * @param offset The view time offset in seconds.
 113          */
 114         void set_scale_offset(double scale, double offset);
 115
 116         std::set< std::shared_ptr<pv::data::SignalData> >
 117                 get_visible_data() const;
 118
 119         std::pair<double, double> get_time_extents() const;
 120
 121         /**
 122          * Returns true if cursors are displayed. false otherwise.
 123          */
 124         bool cursors_shown() const;
 125
 126         /**
 127          * Shows or hides the cursors.
 128          */
 129         void show_cursors(bool show = true);
 130
 131         /**
 132          * Moves the cursors to a convenient position in the view.
 133          */
 134         void centre_cursors();
 135
 136         /**
 137          * Returns a reference to the pair of cursors.
 138          */
 139         CursorPair& cursors();
 140
 141         /**
 142          * Returns a reference to the pair of cursors.
 143          */
 144         const CursorPair& cursors() const;
 145
 146         const QPoint& hover_point() const;
 147
 148         void update_viewport();
 149
 150 Q_SIGNALS:
 151         void hover_point_changed();
 152
 153         void signals_moved();
 154
 155         void selection_changed();
 156
 157         void scale_offset_changed();
 158
 159 private:
 160         void get_scroll_layout(double &length, double &offset) const;
 161
 162         /**
 163          * Simultaneously sets the zoom and offset.
 164          * @param scale The scale to set the view to in seconds per pixel. This
 165          * value is clamped between MinScale and MaxScale.
 166          * @param offset The offset of the left edge of the view in seconds.
 167          */
 168         void set_zoom(double scale, int offset);
 169
 170         void update_scroll();
 171
 172         void update_layout();
 173
 174         /**
 175          * Satisifies RowItem functionality.
 176          * @param p the QPainter to paint into.
 177          * @param right the x-coordinate of the right edge of the header
 178          *      area.
 179          * @param hover true if the label is being hovered over by the mouse.
 180          */
 181         void paint_label(QPainter &p, int right, bool hover);
 182
 183         /**
 184          * Computes the outline rectangle of a label.
 185          * @param right the x-coordinate of the right edge of the header
 186          *      area.
 187          * @return Returns the rectangle of the signal label.
 188          */
 189         QRectF label_rect(int right);
 190
 191 private:
 192         bool eventFilter(QObject *object, QEvent *event);
 193
 194         bool viewportEvent(QEvent *e);
 195
 196         void resizeEvent(QResizeEvent *e);
 197
 198 public:
 199         void appearance_changed(bool label, bool content);
 200
 201         void extents_changed(bool horz, bool vert);
 202
 203 private Q_SLOTS:
 204
 205         void h_scroll_value_changed(int value);
 206         void v_scroll_value_changed(int value);
 207
 208         void signals_changed();
 209         void data_updated();
 210
 211         void marker_time_changed();
 212
 213         void on_signals_moved();
 214
 215         void process_sticky_events();
 216
 217         void on_hover_point_changed();
 218
 219 private:
 220         SigSession &_session;
 221
 222         Viewport *_viewport;
 223         Ruler *_ruler;
 224         CursorHeader *_cursorheader;
 225         Header *_header;
 226
 227         /// The view time scale in seconds per pixel.
 228         double _scale;
 229
 230         /// The view time offset in seconds.
 231         double _offset;
 232
 233         int _v_offset;
 234         bool _updating_scroll;
 235
 236         bool _show_cursors;
 237         CursorPair _cursors;
 238
 239         QPoint _hover_point;
 240
 241         unsigned int _sticky_events;
 242         QTimer _lazy_event_handler;
 243 };
 244
 245 } // namespace view
 246 } // namespace pv
 247
 248 #endif // PULSEVIEW_PV_VIEW_VIEW_H