extracted the scroll events docs in a single file which is now included by all the others
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@16128 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -1,11 +1,12 @@
|
||||
\section{\class{wxScrollEvent}}\label{wxscrollevent}
|
||||
|
||||
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.
|
||||
\helpref{scrollbars}{wxscrollbar} and \helpref{sliders}{wxslider}. 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}
|
||||
|
||||
@@ -17,38 +18,7 @@ for the scrollbar-like controls.
|
||||
|
||||
<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
|
||||
{\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
|
||||
\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 thumbtrack).}
|
||||
\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.}
|
||||
\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 thumbtrack).}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLL\_THUMBRELEASE thumb release events.}
|
||||
\end{twocollist}%
|
||||
\input scrolevt.inc
|
||||
|
||||
\wxheading{Remarks}
|
||||
|
||||
|
Reference in New Issue
Block a user