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

\section{\class{wxScrollWinEvent}}\label{wxscrollwinevent}

A scroll event holds information about events sent from scrolling windows.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/event.h>

\wxheading{Event table macros}

To process a scroll window event, use these event handler macros to direct input to member
functions that take a wxScrollWinEvent argument. You can use the  EVT\_SCROLLWIN... macros
for intercepting scroll window events from the receiving window.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_SCROLLWIN(func)}}{Process all scroll events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_TOP(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-top events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_BOTTOM(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-bottom events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_LINEUP(func)}}{Process wxEVT\_SCROLLWIN\_LINEUP line up events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_LINEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_LINEDOWN line down events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEUP(func)}}{Process wxEVT\_SCROLLWIN\_PAGEUP page up events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_PAGEDOWN page down events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBTRACK(func)}}{Process wxEVT\_SCROLLWIN\_THUMBTRACK thumbtrack events (frequent events
sent as the user drags the thumtrack).}
\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLLWIN\_THUMBRELEASE thumb release events.}
\end{twocollist}%

\wxheading{See also}

%\helpref{wxWindow::OnScroll}{wxwindowonscroll},
\helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxScrollWinEvent::wxScrollWinEvent}

\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0},
\rtfsp\param{int}{ orientation = 0}}

Constructor.

\membersection{wxScrollWinEvent::GetOrientation}\label{wxscrollwineventgetorientation}

\constfunc{int}{GetOrientation}{\void}

Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar.

\membersection{wxScrollWinEvent::GetPosition}\label{wxscrollwineventgetposition}

\constfunc{int}{GetPosition}{\void}

Returns the position of the scrollbar for the thumb track and release events.
Note that this field can't be used for the other events, you need to query
the window itself for the current position in that case.
Commit	Line	Data
fd128b0c RR	1	\section{\class{wxScrollWinEvent}}\label{wxscrollwinevent}
	2
	3	A scroll event holds information about events sent from scrolling windows.
	4
	5	\wxheading{Derived from}
	6
	7	\helpref{wxEvent}{wxevent}\\
	8	\helpref{wxObject}{wxobject}
	9
	10	\wxheading{Include files}
	11
	12	<wx/event.h>
	13
	14	\wxheading{Event table macros}
	15
29b5bcd5 RR	16	To process a scroll window event, use these event handler macros to direct input to member
	17	functions that take a wxScrollWinEvent argument. You can use the EVT\_SCROLLWIN... macros
	18	for intercepting scroll window events from the receiving window.
fd128b0c RR	19
	20	\twocolwidtha{7cm}
	21	\begin{twocollist}\itemsep=0pt
	22	\twocolitem{{\bf EVT\_SCROLLWIN(func)}}{Process all scroll events.}
530a7383 RR	23	\twocolitem{{\bf EVT\_SCROLLWIN\_TOP(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-top events.}
	24	\twocolitem{{\bf EVT\_SCROLLWIN\_BOTTOM(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-bottom events.}
	25	\twocolitem{{\bf EVT\_SCROLLWIN\_LINEUP(func)}}{Process wxEVT\_SCROLLWIN\_LINEUP line up events.}
	26	\twocolitem{{\bf EVT\_SCROLLWIN\_LINEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_LINEDOWN line down events.}
	27	\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEUP(func)}}{Process wxEVT\_SCROLLWIN\_PAGEUP page up events.}
	28	\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_PAGEDOWN page down events.}
	29	\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBTRACK(func)}}{Process wxEVT\_SCROLLWIN\_THUMBTRACK thumbtrack events (frequent events
fd128b0c	30	sent as the user drags the thumtrack).}
530a7383	31	\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLLWIN\_THUMBRELEASE thumb release events.}
fd128b0c RR	32	\end{twocollist}%
	33
	34	\wxheading{See also}
	35
f4fcc291 JS	36	%\helpref{wxWindow::OnScroll}{wxwindowonscroll},
f4fcc291 JS	37	\helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}
fd128b0c RR	38
	39	\latexignore{\rtfignore{\wxheading{Members}}}
	40
	41	\membersection{wxScrollWinEvent::wxScrollWinEvent}
	42
	43	\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0},
	44	\rtfsp\param{int}{ orientation = 0}}
	45
	46	Constructor.
	47
	48	\membersection{wxScrollWinEvent::GetOrientation}\label{wxscrollwineventgetorientation}
	49
	50	\constfunc{int}{GetOrientation}{\void}
	51
	52	Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar.
	53
	54	\membersection{wxScrollWinEvent::GetPosition}\label{wxscrollwineventgetposition}
	55
	56	\constfunc{int}{GetPosition}{\void}
	57
d4486ad2 VZ	58	Returns the position of the scrollbar for the thumb track and release events.
	59	Note that this field can't be used for the other events, you need to query
	60	the window itself for the current position in that case.
	61
fd128b0c	62