]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/scrlwevt.tex
Added DetachOldLog to avoid destruction of old log target
[wxWidgets.git] / docs / latex / wx / scrlwevt.tex
CommitLineData
fd128b0c
RR
1\section{\class{wxScrollWinEvent}}\label{wxscrollwinevent}
2
3A 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
16To process a scroll window event, use these event handler macros to direct input to member
17functions that take a wxScrollWinEvent argument. You can use the EVT\_SCROLLWIN... macros
18for 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 23\twocolitem{{\bf EVT\_SCROLLWIN\_TOP(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-top events.}
c9d9b9c1 24\twocolitem{{\bf EVT\_SCROLLWIN\_BOTTOM(func)}}{Process wxEVT\_SCROLLWIN\_BOTTOM scroll-to-bottom events.}
530a7383
RR
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
2edb0bde 30sent as the user drags the thumbtrack).}
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},
37\helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}
fd128b0c
RR
38
39\latexignore{\rtfignore{\wxheading{Members}}}
40
08f1d438 41\membersection{wxScrollWinEvent::wxScrollWinEvent}\label{wxscrollwineventctor}
fd128b0c 42
9a75ba66 43\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int}{ pos = 0},
fd128b0c
RR
44\rtfsp\param{int}{ orientation = 0}}
45
46Constructor.
47
48\membersection{wxScrollWinEvent::GetOrientation}\label{wxscrollwineventgetorientation}
49
50\constfunc{int}{GetOrientation}{\void}
51
52Returns 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
58Returns the position of the scrollbar for the thumb track and release events.
59Note that this field can't be used for the other events, you need to query
60the window itself for the current position in that case.
61
fd128b0c 62