From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 7 Dec 2011 12:46:15 +0000 (+0000)
Subject: Add documentation of emitted events to wxScrolled documentation.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/2e8c12bcb028f4b3a77e71e7bcc91fc8f156feaa

Add documentation of emitted events to wxScrolled documentation.

Make it clear that wxScrolled<> emits wxScrollWinEvent and not wxScrollEvent.

Closes #13730.

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

diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h
index ac46c7e264..5c027861ab 100644
--- 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