1. made ScrollLines/Pages return bool indicating if we scrolled till the

[wxWidgets.git] / docs / latex / wx / scrolevt.tex

diff --git a/docs/latex/wx/scrolevt.tex b/docs/latex/wx/scrolevt.tex
index 9e70010e879e312ffe0fd539ef0c8b6fa681e9c7..c529ef32e93fe678647e0c14b97c83be7e47595a 100644 (file)
--- a/docs/latex/wx/scrolevt.tex
+++ b/docs/latex/wx/scrolevt.tex
@@ -1,6 +1,11 @@
 \section{\class{wxScrollEvent}}\label{wxscrollevent}
 
-A scroll event holds information about events sent from scrollbars and scrolling windows.
+A scroll event holds information about events sent from stand-alone
+scrollbars, spin-buttons and sliders. Note that starting from wxWindows 2.1,
+scrolled windows send the \helpref{wxScrollWinEvent}{wxscrollwinevent} which
+does not derive from wxCommandEvent, but from wxEvent directly - don't confuse
+these two kinds of events and use the event table macros mentioned below only
+for the scrollbar-like controls.
 
 \wxheading{Derived from}
 
@@ -14,10 +19,12 @@ A scroll event holds information about events sent from scrollbars and scrolling
 
 \wxheading{Event table macros}
 
-To process a scroll event, use these event handler macros to direct input to member
-functions that take a wxScrollEvent argument. You can use EVT\_COMMAND\_SCROLL... macros
-with window IDs for when intercepting scroll events from controls, or EVT\_SCROLL... macros
-without window IDs for intercepting scroll events from the receiving window.
+To process a scroll event, use these event handler macros to direct input to
+member functions that take a wxScrollEvent argument. You can use
+{\tt EVT\_COMMAND\_SCROLL...} macros with window IDs for when intercepting
+scroll events from controls, or {\tt EVT\_SCROLL...} macros without window IDs
+for intercepting scroll events from the receiving window - except for this,
+the macros behave exactly the same
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
@@ -30,6 +37,7 @@ without window IDs for intercepting scroll events from the receiving window.
 \twocolitem{{\bf EVT\_SCROLL\_PAGEDOWN(func)}}{Process wxEVT\_SCROLL\_PAGEDOWN page down events.}
 \twocolitem{{\bf EVT\_SCROLL\_THUMBTRACK(func)}}{Process wxEVT\_SCROLL\_THUMBTRACK thumbtrack events (frequent events
 sent as the user drags the thumtrack).}
+\twocolitem{{\bf EVT\_SCROLL\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLL\_THUMBRELEASE thumb release events.}
 \twocolitem{{\bf EVT\_COMMAND\_SCROLL(id, func)}}{Process all scroll events.}
 \twocolitem{{\bf EVT\_COMMAND\_SCROLL\_TOP(id, func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-top events.}
 \twocolitem{{\bf EVT\_COMMAND\_SCROLL\_BOTTOM(id, func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events.}
@@ -39,6 +47,7 @@ sent as the user drags the thumtrack).}
 \twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEDOWN(id, func)}}{Process wxEVT\_SCROLL\_PAGEDOWN page down events.}
 \twocolitem{{\bf EVT\_COMMAND\_SCROLL\_THUMBTRACK(id, func)}}{Process wxEVT\_SCROLL\_THUMBTRACK thumbtrack events (frequent events
 sent as the user drags the thumtrack).}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLL\_THUMBRELEASE thumb release events.}
 \end{twocollist}%
 
 \wxheading{Remarks}
@@ -49,7 +58,8 @@ horizontal and vertical scroll events are processed using the same event handler
 
 \wxheading{See also}
 
-\helpref{wxWindow::OnScroll}{wxwindowonscroll}, \helpref{wxScrollBar}{wxscrollbar}, \helpref{Event handling overview}{eventhandlingoverview}
+\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxSlider}{wxslider}, \helpref{wxSpinButton}{wxspinbutton}, \\
+\helpref{wxScrollWinEvent}{wxscrollwinevent}, \helpref{Event handling overview}{eventhandlingoverview}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -72,4 +82,3 @@ Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollba
 
 Returns the position of the scrollbar.
 
-