Add doc for SendAutoScrollEvents

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71703 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h
index 5c027861ab02768b71b52071ecc73bb43aa7dd5a..3ce36d736f92cfa3d975695b3118d1653f977d5d 100644 (file)
--- a/interface/wx/scrolwin.h
+++ b/interface/wx/scrolwin.h
@@ -535,8 +535,28 @@ public:
     double GetScaleY() const;
 
     virtual void AdjustScrollbars();
     double GetScaleY() const;
 
     virtual void AdjustScrollbars();

+
+    /**
+       Are we generating the autoscroll events?
+     */

     bool IsAutoScrolling() const;
     bool IsAutoScrolling() const;

+
+    /**
+       Stop generating the scroll events when mouse is held outside the
+       window.
+     */

     void StopAutoScrolling();
     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:
     /**
 
 protected:
     /**