]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/scrolevt.tex
no changes, just come cleanup and more comments
[wxWidgets.git] / docs / latex / wx / scrolevt.tex
... / ...
CommitLineData
1\section{\class{wxScrollEvent}}\label{wxscrollevent}
2
3A scroll event holds information about events sent from stand-alone
4\helpref{scrollbars}{wxscrollbar} and \helpref{sliders}{wxslider}. Note that
5starting from wxWidgets 2.1, scrolled windows send the
6\helpref{wxScrollWinEvent}{wxscrollwinevent} which does not derive from
7wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
8events and use the event table macros mentioned below only for the
9scrollbar-like controls.
10
11\wxheading{Derived from}
12
13\helpref{wxCommandEvent}{wxcommandevent}\\
14\helpref{wxEvent}{wxevent}\\
15\helpref{wxObject}{wxobject}
16
17\wxheading{Include files}
18
19<wx/event.h>
20
21\wxheading{Library}
22
23\helpref{wxCore}{librarieslist}
24
25\input scrolevt.inc
26
27\wxheading{Remarks}
28
29Note that unless specifying a scroll control identifier, you will need to test for scrollbar
30orientation with \helpref{wxScrollEvent::GetOrientation}{wxscrolleventgetorientation}, since
31horizontal and vertical scroll events are processed using the same event handler.
32
33\wxheading{See also}
34
35\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxSlider}{wxslider}, \helpref{wxSpinButton}{wxspinbutton}, \\
36\helpref{wxScrollWinEvent}{wxscrollwinevent}, \helpref{Event handling overview}{eventhandlingoverview}
37
38\latexignore{\rtfignore{\wxheading{Members}}}
39
40\membersection{wxScrollEvent::wxScrollEvent}\label{wxscrolleventctor}
41
42\func{}{wxScrollEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0},
43\rtfsp\param{int}{ orientation = 0}}
44
45Constructor.
46
47\membersection{wxScrollEvent::GetOrientation}\label{wxscrolleventgetorientation}
48
49\constfunc{int}{GetOrientation}{\void}
50
51Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar.
52
53\membersection{wxScrollEvent::GetPosition}\label{wxscrolleventgetposition}
54
55\constfunc{int}{GetPosition}{\void}
56
57Returns the position of the scrollbar.
58