synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / scrolwin.h

diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h
index fea0ad5b279efefa2888a93f63252dce5fdba25b..8a9b9093098712ab03ecaa5a2b640fe028b803c2 100644 (file)
--- a/interface/wx/scrolwin.h
+++ b/interface/wx/scrolwin.h
@@ -103,6 +103,34 @@ enum wxScrollbarVisibility
            Uses a backing pixmap to speed refreshes. Motif only.
     @endStyleTable
 
+
+    @beginEventEmissionTable{wxScrollWinEvent}
+    @event{EVT_SCROLLWIN(func)}
+        Process all scroll events.
+    @event{EVT_SCROLLWIN_TOP(func)}
+        Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
+    @event{EVT_SCROLLWIN_BOTTOM(func)}
+        Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
+    @event{EVT_SCROLLWIN_LINEUP(func)}
+        Process @c wxEVT_SCROLLWIN_LINEUP line up events.
+    @event{EVT_SCROLLWIN_LINEDOWN(func)}
+        Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
+    @event{EVT_SCROLLWIN_PAGEUP(func)}
+        Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
+    @event{EVT_SCROLLWIN_PAGEDOWN(func)}
+        Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
+    @event{EVT_SCROLLWIN_THUMBTRACK(func)}
+        Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
+        (frequent events sent as the user drags the thumbtrack).
+    @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
+        Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
+    @endEventTable
+
+    @note
+        Don't confuse wxScrollWinEvents generated by this class with
+        wxScrollEvent objects generated by wxScrollBar and wxSlider.
+
+
     @remarks
     Use wxScrolled for applications where the user scrolls by a fixed amount,
     and where a 'page' can be interpreted to be the current visible portion of
@@ -493,6 +521,42 @@ public:
         method must be overridden.
     */
     void SetTargetWindow(wxWindow *window);
+    wxWindow *GetTargetWindow() const;
+
+    
+    void SetTargetRect(const wxRect& rect);
+    wxRect GetTargetRect() const;
+
+    int GetScrollPageSize(int orient) const;
+    void SetScrollPageSize(int orient, int pageSize);
+    int GetScrollLines( int orient ) const;
+    void SetScale(double xs, double ys);
+    double GetScaleX() const;
+    double GetScaleY() const;
+
+    virtual void AdjustScrollbars();
+
+    /**
+       Are we generating the autoscroll events?
+     */
+    bool IsAutoScrolling() const;
+
+    /**
+       Stop generating the scroll events when mouse is held outside the
+       window.
+     */
+    void StopAutoScrolling();
+    
+    /**
+       This method can be overridden in a derived class to forbid sending the
+       auto scroll events - note that unlike StopAutoScrolling() it doesn't
+       stop the timer, so it will be called repeatedly and will typically
+       return different values depending on the current mouse position
+    
+       The base class version just returns true.
+    */
+    virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const;
+
 
 protected:
     /**
@@ -514,7 +578,7 @@ protected:
 /**
     Scrolled window derived from wxPanel.
 
-    See wxScrolled for detailed description.
+    See wxScrolled for a detailed description.
 
     @note Note that because this class derives from wxPanel, it shares its
           behaviour with regard to TAB traversal and focus handling (in