added a note that wxStringList is obsolete

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

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index eff02f8b6d0907b66b62f0ffe0ae6abc2f8acf9c..a470265f9ae9d954d6f63eeeb67d2d1ea16a882c 100644 (file)
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -1,7 +1,12 @@
 \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.
+
+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
@@ -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}
@@ -239,7 +250,7 @@ translation set for the DC, which usually indicates that the window has been scr
 \constfunc{int}{GetLinesPerAction}{\void}
 
 Returns the configured number of lines (or whatever) to be scrolled per
-wheel action.  Defaults to one.
+wheel action.  Defaults to three.
 
 \membersection{wxMouseEvent::GetWheelRotation}\label{wxmouseeventgetwheelrotation}