added wxWindow::AlwaysShowScrollbars() and its wxMac implementation

[wxWidgets.git] / docs / latex / wx / scrlwevt.tex

\section{\class{wxScrollWinEvent}}\label{wxscrollwinevent}

A scroll event holds information about events sent from scrolling windows.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/event.h>

\wxheading{Library}

\helpref{wxCore}{librarieslist}

\wxheading{Event table macros}

To process a scroll window event, use these event handler macros to direct input to member
functions that take a wxScrollWinEvent argument. You can use the  EVT\_SCROLLWIN... macros
for intercepting scroll window events from the receiving window.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_SCROLLWIN(func)}}{Process all scroll events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_TOP(func)}}{Process wxEVT\_SCROLLWIN\_TOP scroll-to-top events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_BOTTOM(func)}}{Process wxEVT\_SCROLLWIN\_BOTTOM scroll-to-bottom events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_LINEUP(func)}}{Process wxEVT\_SCROLLWIN\_LINEUP line up events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_LINEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_LINEDOWN line down events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEUP(func)}}{Process wxEVT\_SCROLLWIN\_PAGEUP page up events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEDOWN(func)}}{Process wxEVT\_SCROLLWIN\_PAGEDOWN page down events.}
\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBTRACK(func)}}{Process wxEVT\_SCROLLWIN\_THUMBTRACK thumbtrack events (frequent events
sent as the user drags the thumbtrack).}
\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBRELEASE(func)}}{Process wxEVT\_SCROLLWIN\_THUMBRELEASE thumb release events.}
\end{twocollist}%

\wxheading{See also}

%\helpref{wxWindow::OnScroll}{wxwindowonscroll},
\helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxScrollWinEvent::wxScrollWinEvent}\label{wxscrollwineventctor}

\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int}{ pos = 0},
\rtfsp\param{int}{ orientation = 0}}

Constructor.

\membersection{wxScrollWinEvent::GetOrientation}\label{wxscrollwineventgetorientation}

\constfunc{int}{GetOrientation}{\void}

Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar.

\membersection{wxScrollWinEvent::GetPosition}\label{wxscrollwineventgetposition}

\constfunc{int}{GetPosition}{\void}

Returns the position of the scrollbar for the thumb track and release events.
Note that this field can't be used for the other events, you need to query
the window itself for the current position in that case.