X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f4fcc2919776cffa5e3b2f0d44dd24c41e652ff4..a99acbb00a102458b8ad5ba4459712ba73d8b14d:/docs/latex/wx/mouseevt.tex?ds=sidebyside diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex index 6cb90ed0ff..a26d2b4c76 100644 --- a/docs/latex/wx/mouseevt.tex +++ b/docs/latex/wx/mouseevt.tex @@ -14,15 +14,15 @@ drawbacks: the LEAVE\_WINDOW event might be received some time after the mouse left the window and the state variables for it may have changed during this time. -{\bf NB:} Note the difference between methods like -\helpref{LeftDown}{wxmouseeventleftdown} and -\helpref{LeftIsDown}{wxmouseeventleftisdown}: the format returns {\tt TRUE} +{\bf NB:} Note the difference between methods like +\helpref{LeftDown}{wxmouseeventleftdown} and +\helpref{LeftIsDown}{wxmouseeventleftisdown}: the format returns {\tt TRUE} when the event corresponds to the left mouse button click while the latter returns {\tt TRUE} if the left mouse button is currently being pressed. For -example, when the user is dragging the mouse you can use +example, when the user is dragging the mouse you can use \helpref{LeftIsDown}{wxmouseeventleftisdown} to test whether the left mouse button is (still) depressed. Also, by convention, if -\helpref{LeftDown}{wxmouseeventleftdown} returns {\tt TRUE}, +\helpref{LeftDown}{wxmouseeventleftdown} returns {\tt TRUE}, \helpref{LeftIsDown}{wxmouseeventleftisdown} will also return {\tt TRUE} in wxWindows whatever the underlying GUI behaviour is (which is platform-dependent). The same applies, of course, to other mouse buttons as @@ -291,6 +291,13 @@ Returns Y coordinate of the physical mouse event position. Returns TRUE if the event was a mouse button event (not necessarily a button down event - that may be tested using {\it ButtonDown}). +\membersection{wxMouseEvent::IsPageScroll} + +\constfunc{bool}{IsPageScroll}{\void} + +Returns TRUE if the system has been setup to do page scrolling with +the mouse wheel instead of line scrolling. + \membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving} \constfunc{bool}{Leaving}{\void}