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 <vector>
  27
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/weak_ptr.hpp>
  30
  31 #include <QAbstractScrollArea>
  32 #include <QSizeF>
  33
  34 #include "cursorpair.h"
  35
  36 namespace pv {
  37
  38 class SigSession;
  39
  40 namespace view {
  41
  42 class Header;
  43 class Ruler;
  44 class Trace;
  45 class Viewport;
  46
  47 class View : public QAbstractScrollArea {
  48         Q_OBJECT
  49
  50 private:
  51         static const double MaxScale;
  52         static const double MinScale;
  53
  54         static const int LabelMarginWidth;
  55         static const int RulerHeight;
  56
  57         static const int MaxScrollValue;
  58
  59 public:
  60         static const int SignalHeight;
  61         static const int SignalMargin;
  62         static const int SignalSnapGridSize;
  63
  64         static const QColor CursorAreaColour;
  65
  66         static const QSizeF LabelPadding;
  67
  68 public:
  69         explicit View(SigSession &session, QWidget *parent = 0);
  70
  71         SigSession& session();
  72         const SigSession& session() const;
  73
  74         /**
  75          * Returns the view time scale in seconds per pixel.
  76          */
  77         double scale() const;
  78
  79         /**
  80          * Returns the time offset of the left edge of the view in
  81          * seconds.
  82          */
  83         double offset() const;
  84         int v_offset() const;
  85
  86         void zoom(double steps);
  87         void zoom(double steps, int offset);
  88
  89         /**
  90          * Sets the scale and offset.
  91          * @param scale The new view scale in seconds per pixel.
  92          * @param offset The view time offset in seconds.
  93          */
  94         void set_scale_offset(double scale, double offset);
  95
  96         std::vector< boost::shared_ptr<Trace> > get_traces() const;
  97
  98         std::list<boost::weak_ptr<SelectableItem> > selected_items() const;
  99
 100         /**
 101          * Returns true if cursors are displayed. false otherwise.
 102          */
 103         bool cursors_shown() const;
 104
 105         /**
 106          * Shows or hides the cursors.
 107          */
 108         void show_cursors(bool show = true);
 109
 110         /**
 111          * Moves the cursors to a convenient position in the view.
 112          */
 113         void centre_cursors();
 114
 115         /**
 116          * Returns a reference to the pair of cursors.
 117          */
 118         CursorPair& cursors();
 119
 120         /**
 121          * Returns a reference to the pair of cursors.
 122          */
 123         const CursorPair& cursors() const;
 124
 125         const QPoint& hover_point() const;
 126
 127         void normalize_layout();
 128
 129 signals:
 130         void hover_point_changed();
 131
 132         void signals_moved();
 133
 134         void selection_changed();
 135
 136         void scale_offset_changed();
 137
 138 private:
 139         void get_scroll_layout(double &length, double &offset) const;
 140
 141         void update_scroll();
 142
 143         static bool compare_trace_v_offsets(
 144                 const boost::shared_ptr<pv::view::Trace> &a,
 145                 const boost::shared_ptr<pv::view::Trace> &b);
 146
 147 private:
 148         bool eventFilter(QObject *object, QEvent *event);
 149
 150         bool viewportEvent(QEvent *e);
 151
 152         void resizeEvent(QResizeEvent *e);
 153
 154 private slots:
 155
 156         void h_scroll_value_changed(int value);
 157         void v_scroll_value_changed(int value);
 158
 159         void signals_changed();
 160         void data_updated();
 161
 162         void marker_time_changed();
 163
 164         void on_signals_moved();
 165
 166 private:
 167         SigSession &_session;
 168
 169         Viewport *_viewport;
 170         Ruler *_ruler;
 171         Header *_header;
 172
 173         uint64_t _data_length;
 174
 175         /// The view time scale in seconds per pixel.
 176         double _scale;
 177
 178         /// The view time offset in seconds.
 179         double _offset;
 180
 181         int _v_offset;
 182         bool _updating_scroll;
 183
 184         bool _show_cursors;
 185         CursorPair _cursors;
 186
 187         QPoint _hover_point;
 188 };
 189
 190 } // namespace view
 191 } // namespace pv
 192
 193 #endif // PULSEVIEW_PV_VIEW_VIEW_H