]> sigrok.org Git - pulseview.git/blobdiff - pv/view/view.h
Make member variable underscores a suffix instead of a prefix
[pulseview.git] / pv / view / view.h
index 0413b3d79820c6174aa421d4d89c57d80c58c4cb..dec317ccf9a4f2000cd2ec2406f42998965dd936 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the PulseView project.
  *
  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
  *
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#ifndef PV_VIEW_VIEW_H
-#define PV_VIEW_VIEW_H
+#ifndef PULSEVIEW_PV_VIEW_VIEW_H
+#define PULSEVIEW_PV_VIEW_VIEW_H
 
 #include <stdint.h>
 
+#include <memory>
+#include <set>
+#include <unordered_map>
+#include <vector>
+
 #include <QAbstractScrollArea>
+#include <QSizeF>
+#include <QTimer>
 
-class SigSession;
+#include <pv/data/signaldata.h>
+
+#include "cursorpair.h"
+#include "rowitemowner.h"
 
 namespace pv {
+
+class SigSession;
+
 namespace view {
 
+class CursorHeader;
 class Header;
 class Ruler;
 class Viewport;
 
-class View : public QAbstractScrollArea {
+class View : public QAbstractScrollArea, public RowItemOwner {
        Q_OBJECT
 
+private:
+       enum StickyEvents {
+               SelectableItemHExtentsChanged = 1,
+               SelectableItemVExtentsChanged = 2
+       };
+
 private:
        static const double MaxScale;
        static const double MinScale;
 
-       static const int LabelMarginWidth;
-       static const int RulerHeight;
+       static const int MaxScrollValue;
 
 public:
-       static const int SignalHeight;
+       static const QColor CursorAreaColour;
+
+       static const QSizeF LabelPadding;
 
 public:
        explicit View(SigSession &session, QWidget *parent = 0);
 
        SigSession& session();
+       const SigSession& session() const;
+
+       /**
+        * Returns the view of the owner.
+        */
+       virtual pv::view::View* view();
+
+       /**
+        * Returns the view of the owner.
+        */
+       virtual const pv::view::View* view() const;
+
+       Viewport* viewport();
+
+       const Viewport* viewport() const;
 
+       /**
+        * Returns the view time scale in seconds per pixel.
+        */
        double scale() const;
+
+       /**
+        * Returns the time offset of the left edge of the view in
+        * seconds.
+        */
        double offset() const;
-       int v_offset() const;
+       int owner_visual_v_offset() const;
+
+       /**
+        * Returns the number of nested parents that this row item owner has.
+        */
+       unsigned int depth() const;
 
        void zoom(double steps);
        void zoom(double steps, int offset);
 
+       void zoom_fit();
+
+       void zoom_one_to_one();
+
+       /**
+        * Sets the scale and offset.
+        * @param scale The new view scale in seconds per pixel.
+        * @param offset The view time offset in seconds.
+        */
        void set_scale_offset(double scale, double offset);
 
+       std::set< std::shared_ptr<pv::data::SignalData> >
+               get_visible_data() const;
+
+       std::pair<double, double> get_time_extents() const;
+
+       /**
+        * Returns true if cursors are displayed. false otherwise.
+        */
+       bool cursors_shown() const;
+
+       /**
+        * Shows or hides the cursors.
+        */
+       void show_cursors(bool show = true);
+
+       /**
+        * Moves the cursors to a convenient position in the view.
+        */
+       void centre_cursors();
+
+       /**
+        * Returns a reference to the pair of cursors.
+        */
+       CursorPair& cursors();
+
+       /**
+        * Returns a reference to the pair of cursors.
+        */
+       const CursorPair& cursors() const;
+
+       const QPoint& hover_point() const;
+
+       void update_viewport();
+
+       void restack_all_row_items();
+
+Q_SIGNALS:
+       void hover_point_changed();
+
+       void signals_moved();
+
+       void selection_changed();
+
+       void scale_offset_changed();
+
 private:
+       void get_scroll_layout(double &length, double &offset) const;
+
+       /**
+        * Simultaneously sets the zoom and offset.
+        * @param scale The scale to set the view to in seconds per pixel. This
+        * value is clamped between MinScale and MaxScale.
+        * @param offset The offset of the left edge of the view in seconds.
+        */
+       void set_zoom(double scale, int offset);
+
        void update_scroll();
 
+       void update_layout();
+
+       /**
+        * Satisifies RowItem functionality.
+        * @param p the QPainter to paint into.
+        * @param right the x-coordinate of the right edge of the header
+        *      area.
+        * @param hover true if the label is being hovered over by the mouse.
+        */
+       void paint_label(QPainter &p, int right, bool hover);
+
+       /**
+        * Computes the outline rectangle of a label.
+        * @param right the x-coordinate of the right edge of the header
+        *      area.
+        * @return Returns the rectangle of the signal label.
+        */
+       QRectF label_rect(int right);
+
+       static bool add_channels_to_owner(
+               const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
+               RowItemOwner *owner, int &offset,
+               std::unordered_map<std::shared_ptr<sigrok::Channel>,
+                       std::shared_ptr<Signal> > &signal_map,
+               std::function<bool (std::shared_ptr<RowItem>)> filter_func =
+                       std::function<bool (std::shared_ptr<RowItem>)>());
+
+       static void apply_offset(
+               std::shared_ptr<RowItem> row_item, int &offset);
+
 private:
+       bool eventFilter(QObject *object, QEvent *event);
+
        bool viewportEvent(QEvent *e);
 
        void resizeEvent(QResizeEvent *e);
 
-private slots:
+public:
+       void appearance_changed(bool label, bool content);
+
+       void extents_changed(bool horz, bool vert);
+
+private Q_SLOTS:
+
        void h_scroll_value_changed(int value);
        void v_scroll_value_changed(int value);
 
+       void signals_changed();
        void data_updated();
 
+       void marker_time_changed();
+
+       void on_signals_moved();
+
+       void process_sticky_events();
+
+       void on_hover_point_changed();
+
 private:
-       SigSession &_session;
+       SigSession &session_;
+
+       Viewport *viewport_;
+       Ruler *ruler_;
+       CursorHeader *cursorheader_;
+       Header *header_;
+
+       /// The view time scale in seconds per pixel.
+       double scale_;
 
-       Viewport *_viewport;
-       Ruler *_ruler;
-       Header *_header;
+       /// The view time offset in seconds.
+       double offset_;
 
-       uint64_t _data_length;
+       int v_offset_;
+       bool updating_scroll_;
 
-       double _scale;
-       double _offset;
+       bool show_cursors_;
+       CursorPair cursors_;
 
-       int _v_offset;
+       QPoint hover_point_;
 
-       friend class Viewport;
+       unsigned int sticky_events_;
+       QTimer lazy_event_handler_;
 };
 
 } // namespace view
 } // namespace pv
 
-#endif // PV_VIEW_VIEW_H
+#endif // PULSEVIEW_PV_VIEW_VIEW_H