Fix #121 by implementing sticky scrolling

[pulseview.git] / pv / view / view.hpp

diff --git a/pv/view/view.hpp b/pv/view/view.hpp
index 2e8aebb4c1e80d237dbbf1d1c0a4548a3dbaf11c..b29fb157dce383eec55535fcd187ecf104eaa9b7 100644 (file)
--- a/pv/view/view.hpp
+++ b/pv/view/view.hpp
@@ -18,8 +18,8 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#ifndef PULSEVIEW_PV_VIEW_VIEW_H
-#define PULSEVIEW_PV_VIEW_VIEW_H
+#ifndef PULSEVIEW_PV_VIEW_VIEW_HPP
+#define PULSEVIEW_PV_VIEW_VIEW_HPP
 
 #include <stdint.h>
 
@@ -39,6 +39,10 @@
 #include "flag.hpp"
 #include "rowitemowner.hpp"
 
+namespace sigrok {
+class ChannelGroup;
+}
+
 namespace pv {
 
 class Session;
@@ -48,6 +52,7 @@ namespace view {
 class CursorHeader;
 class Header;
 class Ruler;
+class Trace;
 class Viewport;
 
 class View : public QAbstractScrollArea, public RowItemOwner {
@@ -64,6 +69,7 @@ private:
        static const double MinScale;
 
        static const int MaxScrollValue;
+       static const int MaxViewAutoUpdateRate;
 
        static const int ScaleUnits[3];
 
@@ -108,6 +114,11 @@ public:
         */
        int owner_visual_v_offset() const;
 
+       /**
+        * Sets the visual v-offset.
+        */
+       void set_v_offset(int offset);
+
        /**
         * Returns the SI prefix to apply to the graticule time markings.
         */
@@ -142,6 +153,12 @@ public:
 
        std::pair<double, double> get_time_extents() const;
 
+       /**
+        * Enables or disables sticky scrolling, i.e. the view always shows
+        * the most recent samples when capturing data.
+        */
+       void enable_sticky_scrolling(bool state);
+
        /**
         * Returns true if cursors are displayed. false otherwise.
         */
@@ -190,6 +207,8 @@ Q_SIGNALS:
 
        void scale_offset_changed();
 
+       void sticky_scrolling_changed(bool state);
+
 private:
        void get_scroll_layout(double &length, double &offset) const;
 
@@ -226,16 +245,17 @@ private:
         */
        QRectF label_rect(const QRectF &rect);
 
-       static bool add_channels_to_owner(
+       RowItemOwner* find_prevalent_trace_group(
+               const std::shared_ptr<sigrok::ChannelGroup> &group,
+               const std::unordered_map<std::shared_ptr<sigrok::Channel>,
+                       std::shared_ptr<Signal> > &signal_map);
+
+       static std::vector< std::shared_ptr<Trace> >
+               extract_new_traces_for_channels(
                const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
-               RowItemOwner *owner, int &offset,
-               std::unordered_map<std::shared_ptr<sigrok::Channel>,
+               const 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);
+               std::set< std::shared_ptr<Trace> > &add_list);
 
 private:
        bool eventFilter(QObject *object, QEvent *event);
@@ -258,6 +278,8 @@ private Q_SLOTS:
        void signals_changed();
        void data_updated();
 
+       void perform_delayed_view_update();
+
        void process_sticky_events();
 
        void on_hover_point_changed();
@@ -276,6 +298,8 @@ private:
        double offset_;
 
        bool updating_scroll_;
+       bool sticky_scrolling_;
+       QTimer delayed_view_updater_;
 
        double tick_period_;
        unsigned int tick_prefix_;
@@ -295,4 +319,4 @@ private:
 } // namespace view
 } // namespace pv
 
-#endif // PULSEVIEW_PV_VIEW_VIEW_H
+#endif // PULSEVIEW_PV_VIEW_VIEW_HPP