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