]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/scrlwevt.tex
no changes, just come cleanup and more comments
[wxWidgets.git] / docs / latex / wx / scrlwevt.tex
... / ...
CommitLineData
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{Library}
15
16\helpref{wxCore}{librarieslist}
17
18\wxheading{Event table macros}
19
20To process a scroll window event, use these event handler macros to direct input to member
21functions that take a wxScrollWinEvent argument. You can use the EVT\_SCROLLWIN... macros
22for intercepting scroll window events from the receiving window.
23
24\twocolwidtha{7cm}
25\begin{twocollist}\itemsep=0pt
26\twocolitem{{\bf EVT\_SCROLLWIN(func)}}{Process all scroll events.}
27\twocolitem{{\bf EVT\_SCROLLWIN\_TOP(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-top events.}
28\twocolitem{{\bf EVT\_SCROLLWIN\_BOTTOM(func)}}{Process wxEVT\_SCROLLWIN\_BOTTOM scroll-to-bottom events.}
29\twocolitem{{\bf EVT\_SCROLLWIN\_LINEUP(func)}}{Process wxEVT\_SCROLLWIN\_LINEUP line up events.}
30\twocolitem{{\bf EVT\_SCROLLWIN\_LINEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_LINEDOWN line down events.}
31\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEUP(func)}}{Process wxEVT\_SCROLLWIN\_PAGEUP page up events.}
32\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_PAGEDOWN page down events.}
33\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBTRACK(func)}}{Process wxEVT\_SCROLLWIN\_THUMBTRACK thumbtrack events (frequent events
34sent as the user drags the thumbtrack).}
35\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLLWIN\_THUMBRELEASE thumb release events.}
36\end{twocollist}%
37
38\wxheading{See also}
39
40%\helpref{wxWindow::OnScroll}{wxwindowonscroll},
41\helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}
42
43\latexignore{\rtfignore{\wxheading{Members}}}
44
45\membersection{wxScrollWinEvent::wxScrollWinEvent}\label{wxscrollwineventctor}
46
47\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int}{ pos = 0},
48\rtfsp\param{int}{ orientation = 0}}
49
50Constructor.
51
52\membersection{wxScrollWinEvent::GetOrientation}\label{wxscrollwineventgetorientation}
53
54\constfunc{int}{GetOrientation}{\void}
55
56Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar.
57
58\membersection{wxScrollWinEvent::GetPosition}\label{wxscrollwineventgetposition}
59
60\constfunc{int}{GetPosition}{\void}
61
62Returns the position of the scrollbar for the thumb track and release events.
63Note that this field can't be used for the other events, you need to query
64the window itself for the current position in that case.
65
66