git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxScrollEvent}}\label{wxscrollevent}
	2
	3	A scroll event holds information about events sent from stand-alone scrollbars,
	4	spin-buttons and sliders - starting from wxWindows 2.1, scrolled windows send the
	5	\helpref{wxScrollWinEvent}{wxscrollwinevent} which does not derive from
	6	wxCommandEvent, but from wxEvent directly.
	7
	8	\wxheading{Derived from}
	9
	10	\helpref{wxCommandEvent}{wxcommandevent}\\
	11	\helpref{wxEvent}{wxevent}\\
	12	\helpref{wxObject}{wxobject}
	13
	14	\wxheading{Include files}
	15
	16	<wx/event.h>
	17
	18	\wxheading{Event table macros}
	19
	20	To process a scroll event, use these event handler macros to direct input to member
	21	functions that take a wxScrollEvent argument. You can use EVT\_COMMAND\_SCROLL... macros
	22	with window IDs for when intercepting scroll events from controls, or EVT\_SCROLL... macros
	23	without window IDs for intercepting scroll events from the receiving window.
	24
	25	\twocolwidtha{7cm}
	26	\begin{twocollist}\itemsep=0pt
	27	\twocolitem{{\bf EVT\_SCROLL(func)}}{Process all scroll events.}
	28	\twocolitem{{\bf EVT\_SCROLL\_TOP(func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-top events.}
	29	\twocolitem{{\bf EVT\_SCROLL\_BOTTOM(func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events.}
	30	\twocolitem{{\bf EVT\_SCROLL\_LINEUP(func)}}{Process wxEVT\_SCROLL\_LINEUP line up events.}
	31	\twocolitem{{\bf EVT\_SCROLL\_LINEDOWN(func)}}{Process wxEVT\_SCROLL\_LINEDOWN line down events.}
	32	\twocolitem{{\bf EVT\_SCROLL\_PAGEUP(func)}}{Process wxEVT\_SCROLL\_PAGEUP page up events.}
	33	\twocolitem{{\bf EVT\_SCROLL\_PAGEDOWN(func)}}{Process wxEVT\_SCROLL\_PAGEDOWN page down events.}
	34	\twocolitem{{\bf EVT\_SCROLL\_THUMBTRACK(func)}}{Process wxEVT\_SCROLL\_THUMBTRACK thumbtrack events (frequent events
	35	sent as the user drags the thumtrack).}
	36	\twocolitem{{\bf EVT\_SCROLL\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLL\_THUMBRELEASE thumb release events.}
	37	\twocolitem{{\bf EVT\_COMMAND\_SCROLL(id, func)}}{Process all scroll events.}
	38	\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_TOP(id, func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-top events.}
	39	\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_BOTTOM(id, func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events.}
	40	\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEUP(id, func)}}{Process wxEVT\_SCROLL\_LINEUP line up events.}
	41	\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEDOWN(id, func)}}{Process wxEVT\_SCROLL\_LINEDOWN line down events.}
	42	\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEUP(id, func)}}{Process wxEVT\_SCROLL\_PAGEUP page up events.}
	43	\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEDOWN(id, func)}}{Process wxEVT\_SCROLL\_PAGEDOWN page down events.}
	44	\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_THUMBTRACK(id, func)}}{Process wxEVT\_SCROLL\_THUMBTRACK thumbtrack events (frequent events
	45	sent as the user drags the thumtrack).}
	46	\end{twocollist}%
	47
	48	\wxheading{Remarks}
	49
	50	Note that unless specifying a scroll control identifier, you will need to test for scrollbar
	51	orientation with \helpref{wxScrollEvent::GetOrientation}{wxscrolleventgetorientation}, since
	52	horizontal and vertical scroll events are processed using the same event handler.
	53
	54	\wxheading{See also}
	55
	56	\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxSlider}{wxslider}, \helpref{wxSpinButton}{wxspinbutton}, \\
	57	\helpref{wxScrollWinEvent}{wxscrollwinevent}, \helpref{Event handling overview}{eventhandlingoverview}
	58
	59	\latexignore{\rtfignore{\wxheading{Members}}}
	60
	61	\membersection{wxScrollEvent::wxScrollEvent}
	62
	63	\func{}{wxScrollEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0},
	64	\rtfsp\param{int}{ orientation = 0}}
	65
	66	Constructor.
	67
	68	\membersection{wxScrollEvent::GetOrientation}\label{wxscrolleventgetorientation}
	69
	70	\constfunc{int}{GetOrientation}{\void}
	71
	72	Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar.
	73
	74	\membersection{wxScrollEvent::GetPosition}\label{wxscrolleventgetposition}
	75
	76	\constfunc{int}{GetPosition}{\void}
	77
	78	Returns the position of the scrollbar.
	79