whilst -> while

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

diff --git a/docs/latex/wx/scrolevt.tex b/docs/latex/wx/scrolevt.tex
index 9e70010e879e312ffe0fd539ef0c8b6fa681e9c7..08149752c6fc0a36547e6783ef24472cf30829ea 100644 (file)
--- a/docs/latex/wx/scrolevt.tex
+++ b/docs/latex/wx/scrolevt.tex
@@ -1,6 +1,12 @@
 \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
+\helpref{scrollbars}{wxscrollbar} and \helpref{sliders}{wxslider}. Note that
+starting from wxWidgets 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}
 
@@ -12,34 +18,7 @@ A scroll event holds information about events sent from scrollbars and scrolling
 
 <wx/event.h>
 
-\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.
-
-\twocolwidtha{7cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_SCROLL(func)}}{Process all scroll events.}
-\twocolitem{{\bf EVT\_SCROLL\_TOP(func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-top events.}
-\twocolitem{{\bf EVT\_SCROLL\_BOTTOM(func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events.}
-\twocolitem{{\bf EVT\_SCROLL\_LINEUP(func)}}{Process wxEVT\_SCROLL\_LINEUP line up events.}
-\twocolitem{{\bf EVT\_SCROLL\_LINEDOWN(func)}}{Process wxEVT\_SCROLL\_LINEDOWN line down events.}
-\twocolitem{{\bf EVT\_SCROLL\_PAGEUP(func)}}{Process wxEVT\_SCROLL\_PAGEUP page up events.}
-\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\_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.}
-\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEUP(id, func)}}{Process wxEVT\_SCROLL\_LINEUP line up events.}
-\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEDOWN(id, func)}}{Process wxEVT\_SCROLL\_LINEDOWN line down events.}
-\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEUP(id, func)}}{Process wxEVT\_SCROLL\_PAGEUP page up events.}
-\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).}
-\end{twocollist}%
+\input scrolevt.inc
 
 \wxheading{Remarks}
 
@@ -49,11 +28,12 @@ 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}}}
 
-\membersection{wxScrollEvent::wxScrollEvent}
+\membersection{wxScrollEvent::wxScrollEvent}\label{wxscrolleventctor}
 
 \func{}{wxScrollEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0},
 \rtfsp\param{int}{ orientation = 0}}
@@ -72,4 +52,3 @@ Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollba
 
 Returns the position of the scrollbar.
 
-