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