AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

use symbolic constants instead of raw numbers for mouse buttons

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@20223 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2003-04-15 19:00:14 +00:00
parent 249aad307f
commit 8e7cd32b33
1 changed files with 31 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/latex/wx/mouseevt.tex
View File

@ -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}
\func{bool}{ButtonDClick}{\param{int}{ but = -1}}
\membersection{wxMouseEvent::ButtonDClick}
\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}
@ -224,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}
@ -272,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.