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