]> sigrok.org Git - pulseview.git/blobdiff - pv/view/view.hpp
Fix #121 by implementing sticky scrolling
[pulseview.git] / pv / view / view.hpp
index a23f284825d17534b6edcf11df3a2e302610d661..b29fb157dce383eec55535fcd187ecf104eaa9b7 100644 (file)
  * 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>
 
+#include <list>
 #include <memory>
 #include <set>
 #include <unordered_map>
 #include <pv/data/signaldata.hpp>
 
 #include "cursorpair.hpp"
+#include "flag.hpp"
 #include "rowitemowner.hpp"
 
+namespace sigrok {
+class ChannelGroup;
+}
+
 namespace pv {
 
 class Session;
@@ -46,6 +52,7 @@ namespace view {
 class CursorHeader;
 class Header;
 class Ruler;
+class Trace;
 class Viewport;
 
 class View : public QAbstractScrollArea, public RowItemOwner {
@@ -53,8 +60,8 @@ class View : public QAbstractScrollArea, public RowItemOwner {
 
 private:
        enum StickyEvents {
-               SelectableItemHExtentsChanged = 1,
-               SelectableItemVExtentsChanged = 2
+               RowItemHExtentsChanged = 1,
+               RowItemVExtentsChanged = 2
        };
 
 private:
@@ -62,14 +69,10 @@ private:
        static const double MinScale;
 
        static const int MaxScrollValue;
+       static const int MaxViewAutoUpdateRate;
 
        static const int ScaleUnits[3];
 
-public:
-       static const QColor CursorAreaColour;
-
-       static const QSizeF LabelPadding;
-
 public:
        explicit View(Session &session, QWidget *parent = 0);
 
@@ -105,8 +108,17 @@ public:
         * seconds.
         */
        double offset() const;
+
+       /**
+        * Returns the vertical scroll offset.
+        */
        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.
         */
@@ -141,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.
         */
@@ -159,12 +177,22 @@ public:
        /**
         * Returns a reference to the pair of cursors.
         */
-       CursorPair& cursors();
+       std::shared_ptr<CursorPair> cursors() const;
 
        /**
-        * Returns a reference to the pair of cursors.
+        * Adds a new flag at a specified time.
+        */
+       void add_flag(double time);
+
+       /**
+        * Removes a flag from the list.
+        */
+       void remove_flag(std::shared_ptr<Flag> flag);
+
+       /**
+        * Gets the list of flags.
         */
-       const CursorPair& cursors() const;
+       std::vector< std::shared_ptr<Flag> > flags() const;
 
        const QPoint& hover_point() const;
 
@@ -175,12 +203,12 @@ public:
 Q_SIGNALS:
        void hover_point_changed();
 
-       void signals_moved();
-
        void selection_changed();
 
        void scale_offset_changed();
 
+       void sticky_scrolling_changed(bool state);
+
 private:
        void get_scroll_layout(double &length, double &offset) const;
 
@@ -205,30 +233,29 @@ private:
        /**
         * Satisifies RowItem functionality.
         * @param p the QPainter to paint into.
-        * @param right the x-coordinate of the right edge of the header
-        *      area.
+        * @param rect the rectangle 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);
+       void paint_label(QPainter &p, const QRect &rect, bool hover);
 
        /**
         * Computes the outline rectangle of a label.
-        * @param right the x-coordinate of the right edge of the header
-        *      area.
+        * @param rect the rectangle of the header area.
         * @return Returns the rectangle of the signal label.
         */
-       QRectF label_rect(int right);
+       QRectF label_rect(const QRectF &rect);
+
+       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 bool add_channels_to_owner(
+       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);
@@ -238,21 +265,20 @@ private:
        void resizeEvent(QResizeEvent *e);
 
 public:
-       void appearance_changed(bool label, bool content);
+       void row_item_appearance_changed(bool label, bool content);
+       void time_item_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 v_scroll_value_changed();
 
        void signals_changed();
        void data_updated();
 
-       void marker_time_changed();
-
-       void on_signals_moved();
+       void perform_delayed_view_update();
 
        void process_sticky_events();
 
@@ -263,7 +289,6 @@ private:
 
        Viewport *viewport_;
        Ruler *ruler_;
-       CursorHeader *cursorheader_;
        Header *header_;
 
        /// The view time scale in seconds per pixel.
@@ -272,14 +297,18 @@ private:
        /// The view time offset in seconds.
        double offset_;
 
-       int v_offset_;
        bool updating_scroll_;
+       bool sticky_scrolling_;
+       QTimer delayed_view_updater_;
 
        double tick_period_;
        unsigned int tick_prefix_;
 
        bool show_cursors_;
-       CursorPair cursors_;
+       std::shared_ptr<CursorPair> cursors_;
+
+       std::list< std::shared_ptr<Flag> > flags_;
+       char next_flag_text_;
 
        QPoint hover_point_;
 
@@ -290,4 +319,4 @@ private:
 } // namespace view
 } // namespace pv
 
-#endif // PULSEVIEW_PV_VIEW_VIEW_H
+#endif // PULSEVIEW_PV_VIEW_VIEW_HPP