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