mouseevt.tex

来自「Wxpython Implemented on Windows CE, Sou」· TEX 代码 · 共 495 行 · 第 1/2 页

Returns true if the control key was down at the time of the event.


\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}

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 {\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}

\constfunc{wxPoint}{GetPosition}{\void}

\constfunc{void}{GetPosition}{\param{wxCoord*}{ x}, \param{wxCoord*}{ y}}

\constfunc{void}{GetPosition}{\param{long*}{ x}, \param{long*}{ y}}

Sets *x and *y to the position at which the event occurred.

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}

\constfunc{wxPoint}{GetLogicalPosition}{\param{const wxDC\&}{ dc}}

Returns the logical mouse position in pixels (i.e. translated according to the
translation set for the DC, which usually indicates that the window has been scrolled).



\membersection{wxMouseEvent::GetLinesPerAction}\label{wxmouseeventgetlinesperaction}

\constfunc{int}{GetLinesPerAction}{\void}

Returns the configured number of lines (or whatever) to be scrolled per
wheel action.  Defaults to three.


\membersection{wxMouseEvent::GetWheelRotation}\label{wxmouseeventgetwheelrotation}

\constfunc{int}{GetWheelRotation}{\void}

Get wheel rotation, positive or negative indicates direction of
rotation.  Current devices all send an event when rotation is equal to
+/-WheelDelta, but this allows for finer resolution devices to be
created in the future.  Because of this you shouldn't assume that one
event is equal to 1 line or whatever, but you should be able to either
do partial line scrolling or wait until +/-WheelDelta rotation values
have been accumulated before scrolling.


\membersection{wxMouseEvent::GetWheelDelta}\label{wxmouseeventgetwheeldelta}

\constfunc{int}{GetWheelDelta}{\void}

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.


\membersection{wxMouseEvent::GetX}\label{wxmouseeventgetx}

\constfunc{long}{GetX}{\void}

Returns X coordinate of the physical mouse event position.


\membersection{wxMouseEvent::GetY}\label{wxmouseeventgety}

\func{long}{GetY}{\void}

Returns Y coordinate of the physical mouse event position.


\membersection{wxMouseEvent::IsButton}\label{wxmouseeventisbutton}

\constfunc{bool}{IsButton}{\void}

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}\label{wxmouseeventispagescroll}

\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}

Returns true if the mouse was leaving the window.

See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.


\membersection{wxMouseEvent::LeftDClick}\label{wxmouseeventleftdclick}

\constfunc{bool}{LeftDClick}{\void}

Returns true if the event was a left double click.


\membersection{wxMouseEvent::LeftDown}\label{wxmouseeventleftdown}

\constfunc{bool}{LeftDown}{\void}

Returns true if the left mouse button changed to down.


\membersection{wxMouseEvent::LeftIsDown}\label{wxmouseeventleftisdown}

\constfunc{bool}{LeftIsDown}{\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.

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}\label{wxmouseeventleftup}

\constfunc{bool}{LeftUp}{\void}

Returns true if the left mouse button changed to up.


\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}\label{wxmouseeventmiddledclick}

\constfunc{bool}{MiddleDClick}{\void}

Returns true if the event was a middle double click.


\membersection{wxMouseEvent::MiddleDown}\label{wxmouseeventmiddledown}

\constfunc{bool}{MiddleDown}{\void}

Returns true if the middle mouse button changed to down.


\membersection{wxMouseEvent::MiddleIsDown}\label{wxmouseeventmiddleisdown}

\constfunc{bool}{MiddleIsDown}{\void}

Returns true if the middle mouse button is currently down, independent
of the current event type.


\membersection{wxMouseEvent::MiddleUp}\label{wxmouseeventmiddleup}

\constfunc{bool}{MiddleUp}{\void}

Returns true if the middle mouse button changed to up.


\membersection{wxMouseEvent::Moving}\label{wxmouseeventmoving}

\constfunc{bool}{Moving}{\void}

Returns true if this was a motion event and no mouse buttons were pressed. 
If any mouse button is held pressed, then this method returns \false and 
\helpref{Dragging}{wxmouseeventdragging} returns \true.


\membersection{wxMouseEvent::RightDClick}\label{wxmouseeventrightdclick}

\constfunc{bool}{RightDClick}{\void}

Returns true if the event was a right double click.


\membersection{wxMouseEvent::RightDown}\label{wxmouseeventrightdown}

\constfunc{bool}{RightDown}{\void}

Returns true if the right mouse button changed to down.


\membersection{wxMouseEvent::RightIsDown}\label{wxmouseeventrightisdown}

\constfunc{bool}{RightIsDown}{\void}

Returns true if the right mouse button is currently down, independent
of the current event type.


\membersection{wxMouseEvent::RightUp}\label{wxmouseeventrightup}

\constfunc{bool}{RightUp}{\void}

Returns true if the right mouse button changed to up.


\membersection{wxMouseEvent::ShiftDown}\label{wxmouseeventshiftdown}

\constfunc{bool}{ShiftDown}{\void}

Returns true if the shift key was down at the time of the event.