From: Robin Dunn <robin@alldunn.com>
Date: Fri, 8 Jun 2012 19:26:12 +0000 (+0000)
Subject: Add doc for SendAutoScrollEvents
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/dab0a95babc406b3784c4365aa14cd38dac4fa4c

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 5c027861ab..3ce36d736f 100644
--- a/interface/wx/scrolwin.h
+++ b/interface/wx/scrolwin.h
@@ -535,8 +535,28 @@ public:
     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:
     /**