documented that wxHSCROLL disables wrapping; added comment to the source

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

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index 49553b95021d7c808df74d7cffbec5daefd91acf..75cb7c3c76ed82bb90b316f1ca6a750d54e45374 100644 (file)
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -3,10 +3,11 @@
 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.
+All mouse events involving the buttons use {\tt wxMOUSE\_BTN\_LEFT} for the
+left mouse button, {\tt wxMOUSE\_BTN\_MIDDLE} for the middle one and
+{\tt wxMOUSE\_BTN\_RIGHT} 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
@@ -125,7 +126,7 @@ The distance the mouse wheel is rotated.
 
 \member{int}{m\_wheelDelta}
 
-The wheel delta, normally 120.
+The wheel delta, normally $120$.
 
 \membersection{wxMouseEvent::m\_linesPerAction}
 
@@ -164,21 +165,28 @@ Constructor. Valid event types are:
 
 Returns true if the Alt key was down at the time of the event.
 
-\membersection{wxMouseEvent::Button}
+\membersection{wxMouseEvent::Button}\label{wxmouseeventbutton}
 
 \func{bool}{Button}{\param{int}{ button}}
 
 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.
+values of {\it button} are:
 
-\membersection{wxMouseEvent::ButtonDClick}\label{buttondclick}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\tt wxMOUSE\_BTN\_LEFT}}{check if left button was pressed}
+\twocolitem{{\tt wxMOUSE\_BTN\_MIDDLE}}{check if left button was pressed}
+\twocolitem{{\tt wxMOUSE\_BTN\_RIGHT}}{check if left button was pressed}
+\twocolitem{{\tt wxMOUSE\_BTN\_ANY}}{check if any button was pressed}
+\end{twocollist}
+
+\membersection{wxMouseEvent::ButtonDClick}
 
-\func{bool}{ButtonDClick}{\param{int}{ but = -1}}
+\func{bool}{ButtonDClick}{\param{int}{ but = wxMOUSE\_BTN\_ANY}}
 
 If the argument is omitted, this returns true if the event was a mouse
 double click event. Otherwise the argument specifies which double click event
-was generated (1, 2 or 3 for left, middle and right buttons respectively).
+was generated (see \helpref{Button}{wxmouseeventbutton} for the possible
+values).
 
 \membersection{wxMouseEvent::ButtonDown}
 
@@ -186,7 +194,9 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 If the argument is omitted, this returns true if the event was a mouse
 button down event. Otherwise the argument specifies which button-down event
-was generated (1, 2 or 3 for left, middle and right buttons respectively).
+was generated (see \helpref{Button}{wxmouseeventbutton} for the possible
+values).
+
 
 \membersection{wxMouseEvent::ButtonUp}
 
@@ -194,7 +204,9 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 If the argument is omitted, this returns true if the event was a mouse
 button up event. Otherwise the argument specifies which button-up event
-was generated (1, 2 or 3 for left, middle and right buttons respectively).
+was generated (see \helpref{Button}{wxmouseeventbutton} for the possible
+values).
+
 
 \membersection{wxMouseEvent::ControlDown}
 
@@ -202,12 +214,16 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 Returns true if the control key was down at the time of the event.
 
-\membersection{wxMouseEvent::Dragging}
+\membersection{wxMouseEvent::Dragging}\label{wxmouseeventdragging}
 
 \func{bool}{Dragging}{\void}
 
 Returns true if this was a dragging event (motion while a button is depressed).
 
+\wxheading{See also}
+
+\helpref{Moving}{wxmouseeventmoving}
+
 \membersection{wxMouseEvent::Entering}\label{wxmouseevententering}
 
 \func{bool}{Entering}{\void}
@@ -220,10 +236,11 @@ See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
 
 \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.
+Returns the mouse button which generated this event or {\tt wxMOUSE\_BTN\_NONE} 
+if no button is involved (for mouse move, enter or leave event, for example).
+Otherwise {\tt wxMOUSE\_BTN\_LEFT} is returned for the left button down, up and
+double click events, {\tt wxMOUSE\_BTN\_MIDDLE} and {\tt wxMOUSE\_BTN\_RIGHT} 
+for the same events for the middle and the right buttons respectively.
 
 \membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}
 
@@ -268,7 +285,7 @@ have been accumulated before scrolling.
 
 \constfunc{int}{GetWheelDelta}{\void}
 
-Get wheel delta, normally 120.  This is the threshold for action to be
+Get wheel delta, normally $120$.  This is the threshold for action to be
 taken, and one such action (for example, scrolling one increment)
 should occur for each delta.
 
@@ -370,11 +387,13 @@ of the current event type.
 
 Returns true if the middle mouse button changed to up.
 
-\membersection{wxMouseEvent::Moving}
+\membersection{wxMouseEvent::Moving}\label{wxmouseeventmoving}
 
 \constfunc{bool}{Moving}{\void}
 
-Returns true if this was a motion event (no buttons depressed).
+Returns true if this was a motion event (whether some buttons are currently
+pressed or not, use \helpref{Dragging}{wxmouseeventdragging} if you need to
+distinguish between these situations).
 
 \membersection{wxMouseEvent::RightDClick}