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:
parent
d79b005a94
commit
dd56228c02
@ -49,22 +49,7 @@ to the size of the window and the size of the data.
|
||||
|
||||
See also \helpref{window styles overview}{windowstyles}.
|
||||
|
||||
\wxheading{Event handling}
|
||||
|
||||
To process input from a scrollbar, use one of these event handler macros to direct input to member
|
||||
functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
|
||||
|
||||
\twocolwidtha{7cm}
|
||||
\begin{twocollist}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL(id, func)}}{Catch all scroll commands.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_TOP(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_BOTTOM(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEUP(id, func)}}{Catch a line up command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEDOWN(id, func)}}{Catch a line down command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEUP(id, func)}}{Catch a page up command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEDOWN(id, func)}}{Catch a page down command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_THUMBTRACK(id, func)}}{Catch a thumbtrack command (continuous movement of the scroll thumb).}
|
||||
\end{twocollist}%
|
||||
\input scrolevt.inc
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
|
36
docs/latex/wx/scrolevt.inc
Normal file
36
docs/latex/wx/scrolevt.inc
Normal file
@ -0,0 +1,36 @@
|
||||
\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 (minium position).}
|
||||
\twocolitem{{\bf EVT\_SCROLL\_BOTTOM(func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events (maximum position).}
|
||||
\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\_SCROLL\_ENDSCROLL(func)}}{Process wxEVT\_SCROLL\_ENDSCROLL end of scrolling events (MSW only).}
|
||||
\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 (minimum position).}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_BOTTOM(id, func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events (maximum position).}
|
||||
\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.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_ENDSCROLL(func)}}{Process wxEVT\_SCROLL\_ENDSCROLL end of scrolling events (MSW only).}
|
||||
\end{twocollist}%
|
||||
|
||||
|
@ -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}
|
||||
|
||||
|
@ -36,24 +36,7 @@ Slider events are handled in the same way as a scrollbar.
|
||||
|
||||
See also \helpref{window styles overview}{windowstyles}.
|
||||
|
||||
\wxheading{Event handling}
|
||||
|
||||
To process input from a slider, use one of these event handler macros to direct input to member
|
||||
functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
|
||||
|
||||
\twocolwidtha{7cm}
|
||||
\begin{twocollist}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_SCROLL(id, func)}}{Catch all scroll commands.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_TOP(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_BOTTOM(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_LINEUP(id, func)}}{Catch a line up command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_LINEDOWN(id, func)}}{Catch a line down command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_PAGEUP(id, func)}}{Catch a page up command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_PAGEDOWN(id, func)}}{Catch a page down command.}
|
||||
\twocolitem{{\bf EVT\_COMMAND\_THUMBTRACK(id, func)}}{Catch a thumbtrack command (continuous movement of the scroll thumb).}
|
||||
\twocolitem{{\bf EVT\_SLIDER(id, func)}}{Process a wxEVT\_COMMAND\_SLIDER\_UPDATED event,
|
||||
when the slider is moved. Though provided for backward compatibility, this is obsolete.}
|
||||
\end{twocollist}%
|
||||
\input scrolevt.inc
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user