X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fd128b0c3ab84380d782e45bfa98f181a848df27..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/scrlwevt.tex diff --git a/docs/latex/wx/scrlwevt.tex b/docs/latex/wx/scrlwevt.tex index f77594c843..3f19836004 100644 --- a/docs/latex/wx/scrlwevt.tex +++ b/docs/latex/wx/scrlwevt.tex @@ -13,42 +13,34 @@ A scroll event holds information about events sent from scrolling windows. \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. +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\_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).} +\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} +%\helpref{wxWindow::OnScroll}{wxwindowonscroll}, +\helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxScrollWinEvent::wxScrollWinEvent} +\membersection{wxScrollWinEvent::wxScrollWinEvent}\label{wxscrollwineventctor} -\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}, \param{int}{ pos = 0}, +\func{}{wxScrollWinEvent}{\param{WXTYPE }{commandType = 0}, \param{int}{ pos = 0}, \rtfsp\param{int}{ orientation = 0}} Constructor. @@ -63,6 +55,8 @@ Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollba \constfunc{int}{GetPosition}{\void} -Returns the position of the scrollbar. +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.