X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d13d99aa857157833a7fce7a77796f680131820d..513e0cea96dfcdc066d8b5b751c2874c7bf06a39:/docs/latex/wx/mouseevt.tex

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index a29e7d55e1..a26d2b4c76 100644
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -1,17 +1,22 @@
 \section{\class{wxMouseEvent}}\label{wxmouseevent}
 
-This event class contains information about mouse events.
-See \helpref{wxWindow::OnMouseEvent}{wxwindowonmouseevent}.
+This event class contains information about the events generated by the mouse:
+they include mouse buttons press and release events and mouse move events.
 
-{\bf NB: } Note that under Windows mouse enter and leave events are not natively supported
+All mouse events involving the buttons use $1$ for the left mouse button, $2$
+for the middle one and $3$ for the right one. Note that not all mice have
+a middle button so a portable application should avoid relying on the events
+from it.
+
+{\bf NB:} Note that under Windows mouse enter and leave events are not natively supported
 by the system but are generated by wxWindows itself. This has several
 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
+{\bf NB:} Note the difference between methods like
 \helpref{LeftDown}{wxmouseeventleftdown} and
-\helpref{LeftIsDown}{wxmouseeventleftisdown}: the formet returns {\tt TRUE}
+\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
@@ -167,9 +172,6 @@ Returns TRUE if the identified mouse button is changing state. Valid
 values of {\it button} are 1, 2 or 3 for left, middle and right
 buttons respectively.
 
-Not all mice have middle buttons so a portable application should avoid
-this one.
-
 \membersection{wxMouseEvent::ButtonDClick}\label{buttondclick}
 
 \func{bool}{ButtonDClick}{\param{int}{ but = -1}}
@@ -214,6 +216,15 @@ Returns TRUE if the mouse was entering the window.
 
 See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
 
+\membersection{wxMouseEvent::GetButton}\label{wxmouseeventgetbutton}
+
+\constfunc{int}{GetButton}{\void}
+
+Returns the mouse button which generated this event or $-1$ if no button is
+involved (for mouse move, enter or leave event, for example). The value $1$ is
+returned for the left button down, up and double click events, $2$ and $3$ for
+the same events for the middle and the right buttons respectively.
+
 \membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}
 
 \constfunc{wxPoint}{GetPosition}{\void}
@@ -280,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}
