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}, \helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}
  37
  38 \latexignore{\rtfignore{\wxheading{Members}}}
  39
  40 \membersection{wxScrollWinEvent::wxScrollWinEvent}
  41
  42 \func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0},
  43 \rtfsp\param{int}{ orientation = 0}}
  44
  45 Constructor.
  46
  47 \membersection{wxScrollWinEvent::GetOrientation}\label{wxscrollwineventgetorientation}
  48
  49 \constfunc{int}{GetOrientation}{\void}
  50
  51 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar.
  52
  53 \membersection{wxScrollWinEvent::GetPosition}\label{wxscrollwineventgetposition}
  54
  55 \constfunc{int}{GetPosition}{\void}
  56
  57 Returns the position of the scrollbar.
  58