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
+{\bf NB:} Note that under Windows CE mouse enter and leave events are not natively supported
by the system but are generated by wxWidgets 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
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_LEFT\_DOWN(func)}}{Process a wxEVT\_LEFT\_DOWN event.}
+\twocolitem{{\bf EVT\_LEFT\_DOWN(func)}}{Process a wxEVT\_LEFT\_DOWN event. The
+handler of this event should normally call \helpref{event.Skip()}{wxeventskip} to
+allow the default processing to take place as otherwise the window under mouse
+wouldn't get the focus.}
\twocolitem{{\bf EVT\_LEFT\_UP(func)}}{Process a wxEVT\_LEFT\_UP event.}
\twocolitem{{\bf EVT\_LEFT\_DCLICK(func)}}{Process a wxEVT\_LEFT\_DCLICK event.}
\twocolitem{{\bf EVT\_MIDDLE\_DOWN(func)}}{Process a wxEVT\_MIDDLE\_DOWN event.}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxMouseEvent::m\_altDown}
+\membersection{wxMouseEvent::m\_altDown}\label{wxmouseeventmaltdown}
\member{bool}{m\_altDown}
true if the Alt key is pressed down.
-\membersection{wxMouseEvent::m\_controlDown}
+\membersection{wxMouseEvent::m\_controlDown}\label{wxmouseeventmcontroldown}
\member{bool}{m\_controlDown}
true if control key is pressed down.
-\membersection{wxMouseEvent::m\_leftDown}
+\membersection{wxMouseEvent::m\_leftDown}\label{wxmouseeventmleftdown}
\member{bool}{m\_leftDown}
true if the left mouse button is currently pressed down.
-\membersection{wxMouseEvent::m\_middleDown}
+\membersection{wxMouseEvent::m\_middleDown}\label{wxmouseeventmmiddledown}
\member{bool}{m\_middleDown}
true if the middle mouse button is currently pressed down.
-\membersection{wxMouseEvent::m\_rightDown}
+\membersection{wxMouseEvent::m\_rightDown}\label{wxmouseeventmrightdown}
\member{bool}{m\_rightDown}
true if the right mouse button is currently pressed down.
-\membersection{wxMouseEvent::m\_metaDown}
+\membersection{wxMouseEvent::m\_metaDown}\label{wxmouseeventmmetadown}
\member{bool}{m\_metaDown}
true if the Meta key is pressed down.
-\membersection{wxMouseEvent::m\_shiftDown}
+\membersection{wxMouseEvent::m\_shiftDown}\label{wxmouseeventmshiftdown}
\member{bool}{m\_shiftDown}
true if shift is pressed down.
-\membersection{wxMouseEvent::m\_x}
+\membersection{wxMouseEvent::m\_x}\label{wxmouseeventmx}
\member{long}{m\_x}
X-coordinate of the event.
-\membersection{wxMouseEvent::m\_y}
+\membersection{wxMouseEvent::m\_y}\label{wxmouseeventmy}
\member{long}{m\_y}
Y-coordinate of the event.
-\membersection{wxMouseEvent::m\_wheelRotation}
+\membersection{wxMouseEvent::m\_wheelRotation}\label{wxmouseeventmwheelrotation}
\member{int}{m\_wheelRotation}
The distance the mouse wheel is rotated.
-\membersection{wxMouseEvent::m\_wheelDelta}
+\membersection{wxMouseEvent::m\_wheelDelta}\label{wxmouseeventmwheeldelta}
\member{int}{m\_wheelDelta}
The wheel delta, normally $120$.
-\membersection{wxMouseEvent::m\_linesPerAction}
+\membersection{wxMouseEvent::m\_linesPerAction}\label{wxmouseeventmlinesperaction}
\member{int}{m\_linesPerAction}
-\membersection{wxMouseEvent::wxMouseEvent}
+\membersection{wxMouseEvent::wxMouseEvent}\label{wxmouseeventctor}
-\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}
+\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}}
Constructor. Valid event types are:
\end{itemize}
-\membersection{wxMouseEvent::AltDown}
+\membersection{wxMouseEvent::AltDown}\label{wxmouseeventaltdown}
\func{bool}{AltDown}{\void}
\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\_MIDDLE}}{check if middle button was pressed}
+\twocolitem{{\tt wxMOUSE\_BTN\_RIGHT}}{check if right button was pressed}
\twocolitem{{\tt wxMOUSE\_BTN\_ANY}}{check if any button was pressed}
\end{twocollist}
-\membersection{wxMouseEvent::ButtonDClick}
+\membersection{wxMouseEvent::ButtonDClick}\label{wxmouseeventbuttondclick}
\func{bool}{ButtonDClick}{\param{int}{ but = wxMOUSE\_BTN\_ANY}}
values).
-\membersection{wxMouseEvent::ButtonDown}
+\membersection{wxMouseEvent::ButtonDown}\label{wxmouseeventbuttondown}
\func{bool}{ButtonDown}{\param{int}{ but = -1}}
-\membersection{wxMouseEvent::ButtonUp}
+\membersection{wxMouseEvent::ButtonUp}\label{wxmouseeventbuttonup}
\func{bool}{ButtonUp}{\param{int}{ but = -1}}
-\membersection{wxMouseEvent::ControlDown}
+\membersection{wxMouseEvent::CmdDown}\label{wxmouseeventcmddown}
+
+\constfunc{bool}{CmdDown}{\void}
+
+Same as \helpref{MetaDown}{wxmouseeventmetadown} under Mac, same as
+\helpref{ControlDown}{wxmouseeventcontroldown} elsewhere.
+
+\wxheading{See also}
+
+\helpref{wxKeyEvent::CmdDown}{wxkeyeventcmddown}
+
+
+\membersection{wxMouseEvent::ControlDown}\label{wxmouseeventcontroldown}
\func{bool}{ControlDown}{\void}
Returns the physical mouse position in pixels.
+Note that if the mouse event has been artificially generated from a special
+keyboard combination (e.g. under Windows when the ``menu'' key is pressed), the
+returned position is \texttt{wxDefaultPosition}.
+
\membersection{wxMouseEvent::GetLogicalPosition}\label{wxmouseeventgetlogicalposition}
Returns Y coordinate of the physical mouse event position.
-\membersection{wxMouseEvent::IsButton}
+\membersection{wxMouseEvent::IsButton}\label{wxmouseeventisbutton}
\constfunc{bool}{IsButton}{\void}
that may be tested using {\it ButtonDown}).
-\membersection{wxMouseEvent::IsPageScroll}
+\membersection{wxMouseEvent::IsPageScroll}\label{wxmouseeventispagescroll}
\constfunc{bool}{IsPageScroll}{\void}
See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
-\membersection{wxMouseEvent::LeftDClick}
+\membersection{wxMouseEvent::LeftDClick}\label{wxmouseeventleftdclick}
\constfunc{bool}{LeftDClick}{\void}
Returns true if the left mouse button is currently down, independent
of the current event type.
-Please notice that it is {\bf not} the same as
-\helpref{LeftDown}{wxmouseeventleftdown} which returns true if the left mouse
-button was just pressed. Rather, it describes the state of the mouse button
-before the event happened.
+Please notice that it is \emph{not} the same as
+\helpref{LeftDown}{wxmouseeventleftdown} which returns \true if the event was
+generated by the left mouse button being pressed. Rather, it simply describes
+the state of the left mouse button at the time when the event was generated
+(so while it will be true for a left click event, it can also be true for
+a right click if it happened while the left mouse button was pressed).
This event is usually used in the mouse event handlers which process "move
mouse" messages to determine whether the user is (still) dragging the mouse.
-\membersection{wxMouseEvent::LeftUp}
+\membersection{wxMouseEvent::LeftUp}\label{wxmouseeventleftup}
\constfunc{bool}{LeftUp}{\void}
Returns true if the left mouse button changed to up.
-\membersection{wxMouseEvent::MetaDown}
+\membersection{wxMouseEvent::MetaDown}\label{wxmouseeventmetadown}
\constfunc{bool}{MetaDown}{\void}
Returns true if the Meta key was down at the time of the event.
-\membersection{wxMouseEvent::MiddleDClick}
+\membersection{wxMouseEvent::MiddleDClick}\label{wxmouseeventmiddledclick}
\constfunc{bool}{MiddleDClick}{\void}
Returns true if the event was a middle double click.
-\membersection{wxMouseEvent::MiddleDown}
+\membersection{wxMouseEvent::MiddleDown}\label{wxmouseeventmiddledown}
\constfunc{bool}{MiddleDown}{\void}
of the current event type.
-\membersection{wxMouseEvent::MiddleUp}
+\membersection{wxMouseEvent::MiddleUp}\label{wxmouseeventmiddleup}
\constfunc{bool}{MiddleUp}{\void}
\helpref{Dragging}{wxmouseeventdragging} returns \true.
-\membersection{wxMouseEvent::RightDClick}
+\membersection{wxMouseEvent::RightDClick}\label{wxmouseeventrightdclick}
\constfunc{bool}{RightDClick}{\void}
Returns true if the event was a right double click.
-\membersection{wxMouseEvent::RightDown}
+\membersection{wxMouseEvent::RightDown}\label{wxmouseeventrightdown}
\constfunc{bool}{RightDown}{\void}
of the current event type.
-\membersection{wxMouseEvent::RightUp}
+\membersection{wxMouseEvent::RightUp}\label{wxmouseeventrightup}
\constfunc{bool}{RightUp}{\void}
Returns true if the right mouse button changed to up.
-\membersection{wxMouseEvent::ShiftDown}
+\membersection{wxMouseEvent::ShiftDown}\label{wxmouseeventshiftdown}
\constfunc{bool}{ShiftDown}{\void}
projects / wxWidgets.git / blobdiff