docs/latex/wx/scrlwevt.tex

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