fd128b0c3a
Added docs for wxScrollWinEvent and corrected docs referring
to wxScrollEvent etc.
wxTreeCtrl's and wxListCtrl's ::EditLabel() returns void.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3150 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
69 lines
3.2 KiB
TeX
69 lines
3.2 KiB
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{Event table macros}
|
|
|
|
To process a scroll event, use these event handler macros to direct input to member
|
|
functions that take a wxScrollEvent argument. You can use EVT\_COMMAND\_SCROLLWIN... macros
|
|
with window IDs for when intercepting scroll events from controls, or EVT\_SCROLLWIN... macros
|
|
without window IDs for intercepting scroll 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\_SCROLL\_TOP scroll-to-top events.}
|
|
\twocolitem{{\bf EVT\_SCROLLWIN\_BOTTOM(func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events.}
|
|
\twocolitem{{\bf EVT\_SCROLLWIN\_LINEUP(func)}}{Process wxEVT\_SCROLL\_LINEUP line up events.}
|
|
\twocolitem{{\bf EVT\_SCROLLWIN\_LINEDOWN(func)}}{Process wxEVT\_SCROLL\_LINEDOWN line down events.}
|
|
\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEUP(func)}}{Process wxEVT\_SCROLL\_PAGEUP page up events.}
|
|
\twocolitem{{\bf EVT\_SCROLLWIN\_PAGEDOWN(func)}}{Process wxEVT\_SCROLL\_PAGEDOWN page down events.}
|
|
\twocolitem{{\bf EVT\_SCROLLWIN\_THUMBTRACK(func)}}{Process wxEVT\_SCROLL\_THUMBTRACK thumbtrack events (frequent events
|
|
sent as the user drags the thumtrack).}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN(id, func)}}{Process all scroll events.}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN\_TOP(id, func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-top events.}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN\_BOTTOM(id, func)}}{Process wxEVT\_SCROLL\_TOP scroll-to-bottom events.}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN\_LINEUP(id, func)}}{Process wxEVT\_SCROLL\_LINEUP line up events.}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN\_LINEDOWN(id, func)}}{Process wxEVT\_SCROLL\_LINEDOWN line down events.}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN\_PAGEUP(id, func)}}{Process wxEVT\_SCROLL\_PAGEUP page up events.}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN\_PAGEDOWN(id, func)}}{Process wxEVT\_SCROLL\_PAGEDOWN page down events.}
|
|
\twocolitem{{\bf EVT\_COMMAND\_SCROLLWIN\_THUMBTRACK(id, func)}}{Process wxEVT\_SCROLL\_THUMBTRACK thumbtrack events (frequent events
|
|
sent as the user drags the thumtrack).}
|
|
\end{twocollist}%
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxWindow::OnScroll}{wxwindowonscroll}, \helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxScrollWinEvent::wxScrollWinEvent}
|
|
|
|
\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 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.
|
|
|
|
|