projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| fd128b0c RR |
1 | \section{\class{wxScrollWinEvent}}\label{wxscrollwinevent} |
| 2 | ||
| 3 | A 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 | ||
| a7af285d VZ |
14 | \wxheading{Library} |
| 15 | ||
| 16 | \helpref{wxCore}{librarieslist} | |
| 17 | ||
| fd128b0c RR |
18 | \wxheading{Event table macros} |
| 19 | ||
| 29b5bcd5 RR |
20 | To process a scroll window event, use these event handler macros to direct input to member |
| 21 | functions that take a wxScrollWinEvent argument. You can use the EVT\_SCROLLWIN... macros | |
| 22 | for intercepting scroll window events from the receiving window. | |
| fd128b0c RR |
23 | |
| 24 | \twocolwidtha{7cm} | |
| 25 | \begin{twocollist}\itemsep=0pt | |
| 26 | \twocolitem{{\bf EVT\_SCROLLWIN(func)}}{Process all scroll events.} | |
| 530a7383 | 27 | \twocolitem{{\bf EVT\_SCROLLWIN\_TOP(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-top events.} |
| c9d9b9c1 | 28 | \twocolitem{{\bf EVT\_SCROLLWIN\_BOTTOM(func)}}{Process wxEVT\_SCROLLWIN\_BOTTOM scroll-to-bottom events.} |
| 530a7383 RR |
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 | |
| 2edb0bde | 34 | sent as the user drags the thumbtrack).} |
| 530a7383 | 35 | \twocolitem{{\bf EVT\_SCROLLWIN\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLLWIN\_THUMBRELEASE thumb release events.} |
| fd128b0c RR |
36 | \end{twocollist}% |
| 37 | ||
| 38 | \wxheading{See also} | |
| 39 | ||
| f4fcc291 JS |
40 | %\helpref{wxWindow::OnScroll}{wxwindowonscroll}, |
| 41 | \helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview} | |
| fd128b0c RR |
42 | |
| 43 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 44 | ||
| 08f1d438 | 45 | \membersection{wxScrollWinEvent::wxScrollWinEvent}\label{wxscrollwineventctor} |
| fd128b0c | 46 | |
| 9a75ba66 | 47 | \func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int}{ pos = 0}, |
| fd128b0c RR |
48 | \rtfsp\param{int}{ orientation = 0}} |
| 49 | ||
| 50 | Constructor. | |
| 51 | ||
| 52 | \membersection{wxScrollWinEvent::GetOrientation}\label{wxscrollwineventgetorientation} | |
| 53 | ||
| 54 | \constfunc{int}{GetOrientation}{\void} | |
| 55 | ||
| 56 | Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar. | |
| 57 | ||
| 58 | \membersection{wxScrollWinEvent::GetPosition}\label{wxscrollwineventgetposition} | |
| 59 | ||
| 60 | \constfunc{int}{GetPosition}{\void} | |
| 61 | ||
| d4486ad2 VZ |
62 | Returns the position of the scrollbar for the thumb track and release events. |
| 63 | Note that this field can't be used for the other events, you need to query | |
| 64 | the window itself for the current position in that case. | |
| 65 | ||
| fd128b0c | 66 |