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

\section{\class{wxMouseEvent}}\label{wxmouseevent}

This event class contains information about mouse events.
See \helpref{wxWindow::OnMouseEvent}{wxwindowonmouseevent}.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}

\wxheading{Include files}

<wx/event.h>

\wxheading{Event table macros}

To process a mouse event, use these event handler macros to direct input to member
functions that take a wxMouseEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_LEFT\_DOWN(func)}}{Process a wxEVT\_LEFT\_DOWN event.}
\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.}
\twocolitem{{\bf EVT\_MIDDLE\_UP(func)}}{Process a wxEVT\_MIDDLE\_UP event.}
\twocolitem{{\bf EVT\_MIDDLE\_DCLICK(func)}}{Process a wxEVT\_MIDDLE\_DCLICK event.}
\twocolitem{{\bf EVT\_RIGHT\_DOWN(func)}}{Process a wxEVT\_RIGHT\_DOWN event.}
\twocolitem{{\bf EVT\_RIGHT\_UP(func)}}{Process a wxEVT\_RIGHT\_UP event.}
\twocolitem{{\bf EVT\_RIGHT\_DCLICK(func)}}{Process a wxEVT\_RIGHT\_DCLICK event.}
\twocolitem{{\bf EVT\_MOTION(func)}}{Process a wxEVT\_MOTION event.}
\twocolitem{{\bf EVT\_ENTER\_WINDOW(func)}}{Process a wxEVT\_ENTER\_WINDOW event.}
\twocolitem{{\bf EVT\_LEAVE\_WINDOW(func)}}{Process a wxEVT\_LEAVE\_WINDOW event.}
\twocolitem{{\bf EVT\_MOUSE\_EVENTS(func)}}{Process all mouse events.}
\end{twocollist}%

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxMouseEvent::m\_altDown}

\member{bool}{m\_altDown}

TRUE if the Alt key is pressed down.

\membersection{wxMouseEvent::m\_controlDown}

\member{bool}{m\_controlDown}

TRUE if control key is pressed down.

\membersection{wxMouseEvent::m\_leftDown}

\member{bool}{m\_leftDown}

TRUE if the left mouse button is currently pressed down.

\membersection{wxMouseEvent::m\_middleDown}

\member{bool}{m\_middleDown}

TRUE if the middle mouse button is currently pressed down.

\membersection{wxMouseEvent::m\_rightDown}

\member{bool}{m\_rightDown}

TRUE if the right mouse button is currently pressed down.

\membersection{wxMouseEvent::m\_leftDown}

\member{bool}{m\_leftDown}

TRUE if the left mouse button is currently pressed down.

\membersection{wxMouseEvent::m\_metaDown}

\member{bool}{m\_metaDown}

TRUE if the Meta key is pressed down.

\membersection{wxMouseEvent::m\_shiftDown}

\member{bool}{m\_shiftDown}

TRUE if shift is pressed down.

\membersection{wxMouseEvent::m\_x}

\member{long}{m\_x}

X-coordinate of the event.

\membersection{wxMouseEvent::m\_y}

\member{long}{m\_y}

Y-coordinate of the event.

\membersection{wxMouseEvent::wxMouseEvent}

\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}

Constructor. Valid event types are:

\begin{itemize}
\itemsep=0pt
\item {\bf wxEVT\_ENTER\_WINDOW}
\item {\bf wxEVT\_LEAVE\_WINDOW}
\item {\bf wxEVT\_LEFT\_DOWN}
\item {\bf wxEVT\_LEFT\_UP}
\item {\bf wxEVT\_LEFT\_DCLICK}
\item {\bf wxEVT\_MIDDLE\_DOWN}
\item {\bf wxEVT\_MIDDLE\_UP}
\item {\bf wxEVT\_MIDDLE\_DCLICK}
\item {\bf wxEVT\_RIGHT\_DOWN}
\item {\bf wxEVT\_RIGHT\_UP}
\item {\bf wxEVT\_RIGHT\_DCLICK}
\item {\bf wxEVT\_MOTION}
\end{itemize}

\membersection{wxMouseEvent::AltDown}

\func{bool}{AltDown}{\void}

Returns TRUE if the Alt key was down at the time of the event.

\membersection{wxMouseEvent::Button}

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

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

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).

\membersection{wxMouseEvent::ButtonDown}

\func{bool}{ButtonDown}{\param{int}{ but = -1}}

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).

\membersection{wxMouseEvent::ButtonUp}

\func{bool}{ButtonUp}{\param{int}{ but = -1}}

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).

\membersection{wxMouseEvent::ControlDown}

\func{bool}{ControlDown}{\void}

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

\membersection{wxMouseEvent::Dragging}

\func{bool}{Dragging}{\void}

Returns TRUE if this was a dragging event (motion while a button is depressed).

\membersection{wxMouseEvent::Entering}\label{wxmouseevententering}

\func{bool}{Entering}{\void}

Returns TRUE if the mouse was entering the window (MS Windows and Motif).

See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.

\membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}

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

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

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

\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::Leaving}\label{wxmouseeventleaving}

\constfunc{bool}{Leaving}{\void}

Returns TRUE if the mouse was leaving the window (MS Windows and Motif).

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

\membersection{wxMouseEvent::LeftDClick}

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

Returns TRUE if the event was a left double click.

\membersection{wxMouseEvent::LeftDown}

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

Returns TRUE if the left mouse button changed to down.

\membersection{wxMouseEvent::LeftIsDown}

\constfunc{bool}{LeftIsDown}{\void}

Returns TRUE if the left mouse button is currently down, independent
of the current event type.

\membersection{wxMouseEvent::LeftUp}

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

Returns TRUE if the left mouse button changed to up.

\membersection{wxMouseEvent::MetaDown}

\constfunc{bool}{MetaDown}{\void}

Returns TRUE if the Meta key was down at the time of the event.

\membersection{wxMouseEvent::MiddleDClick}

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

Returns TRUE if the event was a middle double click.

\membersection{wxMouseEvent::MiddleDown}

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

Returns TRUE if the middle mouse button changed to down.

\membersection{wxMouseEvent::MiddleIsDown}

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

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

\membersection{wxMouseEvent::MiddleUp}

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

Returns TRUE if the middle mouse button changed to up.

\membersection{wxMouseEvent::Moving}

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

Returns TRUE if this was a motion event (no buttons depressed).

\membersection{wxMouseEvent::RightDClick}

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

Returns TRUE if the event was a right double click.

\membersection{wxMouseEvent::RightDown}

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

Returns TRUE if the right mouse button changed to down.

\membersection{wxMouseEvent::RightIsDown}

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

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

\membersection{wxMouseEvent::RightUp}

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

Returns TRUE if the right mouse button changed to up.

\membersection{wxMouseEvent::ShiftDown}

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

Returns TRUE if the shift key was down at the time of the event.
Commit	Line	Data
a660d684 KB	1	\section{\class{wxMouseEvent}}\label{wxmouseevent}
a660d684 KB	2
fe604ccd JS	3	This event class contains information about mouse events.
fe604ccd JS	4	See \helpref{wxWindow::OnMouseEvent}{wxwindowonmouseevent}.
a660d684 KB	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxEvent}{wxevent}
	9
954b8ae6 JS	10	\wxheading{Include files}
	11
	12	<wx/event.h>
	13
a660d684 KB	14	\wxheading{Event table macros}
	15
	16	To process a mouse event, use these event handler macros to direct input to member
	17	functions that take a wxMouseEvent argument.
	18
	19	\twocolwidtha{7cm}
	20	\begin{twocollist}\itemsep=0pt
	21	\twocolitem{{\bf EVT\_LEFT\_DOWN(func)}}{Process a wxEVT\_LEFT\_DOWN event.}
	22	\twocolitem{{\bf EVT\_LEFT\_UP(func)}}{Process a wxEVT\_LEFT\_UP event.}
	23	\twocolitem{{\bf EVT\_LEFT\_DCLICK(func)}}{Process a wxEVT\_LEFT\_DCLICK event.}
	24	\twocolitem{{\bf EVT\_MIDDLE\_DOWN(func)}}{Process a wxEVT\_MIDDLE\_DOWN event.}
	25	\twocolitem{{\bf EVT\_MIDDLE\_UP(func)}}{Process a wxEVT\_MIDDLE\_UP event.}
	26	\twocolitem{{\bf EVT\_MIDDLE\_DCLICK(func)}}{Process a wxEVT\_MIDDLE\_DCLICK event.}
	27	\twocolitem{{\bf EVT\_RIGHT\_DOWN(func)}}{Process a wxEVT\_RIGHT\_DOWN event.}
	28	\twocolitem{{\bf EVT\_RIGHT\_UP(func)}}{Process a wxEVT\_RIGHT\_UP event.}
	29	\twocolitem{{\bf EVT\_RIGHT\_DCLICK(func)}}{Process a wxEVT\_RIGHT\_DCLICK event.}
	30	\twocolitem{{\bf EVT\_MOTION(func)}}{Process a wxEVT\_MOTION event.}
	31	\twocolitem{{\bf EVT\_ENTER\_WINDOW(func)}}{Process a wxEVT\_ENTER\_WINDOW event.}
	32	\twocolitem{{\bf EVT\_LEAVE\_WINDOW(func)}}{Process a wxEVT\_LEAVE\_WINDOW event.}
5de76427	33	\twocolitem{{\bf EVT\_MOUSE\_EVENTS(func)}}{Process all mouse events.}
a660d684 KB	34	\end{twocollist}%
	35
	36	\latexignore{\rtfignore{\wxheading{Members}}}
	37
	38	\membersection{wxMouseEvent::m\_altDown}
	39
	40	\member{bool}{m\_altDown}
	41
	42	TRUE if the Alt key is pressed down.
	43
	44	\membersection{wxMouseEvent::m\_controlDown}
	45
	46	\member{bool}{m\_controlDown}
	47
	48	TRUE if control key is pressed down.
	49
	50	\membersection{wxMouseEvent::m\_leftDown}
	51
	52	\member{bool}{m\_leftDown}
	53
	54	TRUE if the left mouse button is currently pressed down.
	55
	56	\membersection{wxMouseEvent::m\_middleDown}
	57
	58	\member{bool}{m\_middleDown}
	59
	60	TRUE if the middle mouse button is currently pressed down.
	61
	62	\membersection{wxMouseEvent::m\_rightDown}
	63
	64	\member{bool}{m\_rightDown}
	65
	66	TRUE if the right mouse button is currently pressed down.
	67
	68	\membersection{wxMouseEvent::m\_leftDown}
	69
	70	\member{bool}{m\_leftDown}
	71
	72	TRUE if the left mouse button is currently pressed down.
	73
	74	\membersection{wxMouseEvent::m\_metaDown}
	75
	76	\member{bool}{m\_metaDown}
	77
	78	TRUE if the Meta key is pressed down.
	79
	80	\membersection{wxMouseEvent::m\_shiftDown}
	81
	82	\member{bool}{m\_shiftDown}
	83
	84	TRUE if shift is pressed down.
	85
	86	\membersection{wxMouseEvent::m\_x}
	87
803ef874	88	\member{long}{m\_x}
a660d684 KB	89
	90	X-coordinate of the event.
	91
	92	\membersection{wxMouseEvent::m\_y}
	93
803ef874	94	\member{long}{m\_y}
a660d684 KB	95
	96	Y-coordinate of the event.
	97
	98	\membersection{wxMouseEvent::wxMouseEvent}
	99
	100	\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}
	101
	102	Constructor. Valid event types are:
	103
	104	\begin{itemize}
	105	\itemsep=0pt
	106	\item {\bf wxEVT\_ENTER\_WINDOW}
	107	\item {\bf wxEVT\_LEAVE\_WINDOW}
	108	\item {\bf wxEVT\_LEFT\_DOWN}
	109	\item {\bf wxEVT\_LEFT\_UP}
	110	\item {\bf wxEVT\_LEFT\_DCLICK}
	111	\item {\bf wxEVT\_MIDDLE\_DOWN}
	112	\item {\bf wxEVT\_MIDDLE\_UP}
	113	\item {\bf wxEVT\_MIDDLE\_DCLICK}
	114	\item {\bf wxEVT\_RIGHT\_DOWN}
	115	\item {\bf wxEVT\_RIGHT\_UP}
	116	\item {\bf wxEVT\_RIGHT\_DCLICK}
	117	\item {\bf wxEVT\_MOTION}
	118	\end{itemize}
	119
	120	\membersection{wxMouseEvent::AltDown}
	121
	122	\func{bool}{AltDown}{\void}
	123
	124	Returns TRUE if the Alt key was down at the time of the event.
	125
	126	\membersection{wxMouseEvent::Button}
	127
	128	\func{bool}{Button}{\param{int}{ button}}
	129
	130	Returns TRUE if the identified mouse button is changing state. Valid
	131	values of {\it button} are 1, 2 or 3 for left, middle and right
	132	buttons respectively.
	133
	134	Not all mice have middle buttons so a portable application should avoid
	135	this one.
	136
	137	\membersection{wxMouseEvent::ButtonDClick}\label{buttondclick}
	138
	139	\func{bool}{ButtonDClick}{\param{int}{ but = -1}}
	140
	141	If the argument is omitted, this returns TRUE if the event was a mouse
	142	double click event. Otherwise the argument specifies which double click event
	143	was generated (1, 2 or 3 for left, middle and right buttons respectively).
	144
	145	\membersection{wxMouseEvent::ButtonDown}
	146
	147	\func{bool}{ButtonDown}{\param{int}{ but = -1}}
	148
	149	If the argument is omitted, this returns TRUE if the event was a mouse
	150	button down event. Otherwise the argument specifies which button-down event
	151	was generated (1, 2 or 3 for left, middle and right buttons respectively).
	152
	153	\membersection{wxMouseEvent::ButtonUp}
	154
	155	\func{bool}{ButtonUp}{\param{int}{ but = -1}}
	156
	157	If the argument is omitted, this returns TRUE if the event was a mouse
	158	button up event. Otherwise the argument specifies which button-up event
159	was generated (1, 2 or 3 for left, middle and right buttons respectively).
160
161	\membersection{wxMouseEvent::ControlDown}
162
163	\func{bool}{ControlDown}{\void}
164
165	Returns TRUE if the control key was down at the time of the event.
166
167	\membersection{wxMouseEvent::Dragging}
168
169	\func{bool}{Dragging}{\void}
170
171	Returns TRUE if this was a dragging event (motion while a button is depressed).
172
173	\membersection{wxMouseEvent::Entering}\label{wxmouseevententering}
174
175	\func{bool}{Entering}{\void}
176
fe604ccd	177	Returns TRUE if the mouse was entering the window (MS Windows and Motif).
a660d684 KB	178
	179	See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
	180
803ef874 JS	181	\membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}
	182
	183	\constfunc{wxPoint}{GetPosition}{\void}
	184
	185	\constfunc{void}{GetPosition}{\param{long }{x}, \param{long }{y}}
	186
	187	Sets x and y to the position at which the event occurred.
	188
	189	Returns the physical mouse position in pixels.
	190
	191	\membersection{wxMouseEvent::GetLogicalPosition}\label{wxmouseeventgetlogicalposition}
	192
	193	\constfunc{wxPoint}{GetLogicalPosition}{\param{const wxDC\&}{ dc}}
	194
	195	Returns the logical mouse position in pixels (i.e. translated according to the
	196	translation set for the DC, which usually indicates that the window has been scrolled).
	197
a660d684 KB	198	\membersection{wxMouseEvent::GetX}\label{wxmouseeventgetx}
a660d684 KB	199
803ef874	200	\constfunc{long}{GetX}{\void}
a660d684	201
803ef874	202	Returns X coordinate of the physical mouse event position.
a660d684 KB	203
	204	\membersection{wxMouseEvent::GetY}\label{wxmouseeventgety}
	205
803ef874	206	\func{long}{GetY}{\void}
a660d684	207
803ef874	208	Returns Y coordinate of the physical mouse event position.
a660d684 KB	209
	210	\membersection{wxMouseEvent::IsButton}
	211
803ef874	212	\constfunc{bool}{IsButton}{\void}
a660d684 KB	213
	214	Returns TRUE if the event was a mouse button event (not necessarily a button down event -
	215	that may be tested using {\it ButtonDown}).
	216
	217	\membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving}
	218
803ef874	219	\constfunc{bool}{Leaving}{\void}
a660d684	220
fe604ccd	221	Returns TRUE if the mouse was leaving the window (MS Windows and Motif).
a660d684 KB	222
	223	See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
	224
	225	\membersection{wxMouseEvent::LeftDClick}
	226
803ef874	227	\constfunc{bool}{LeftDClick}{\void}
a660d684 KB	228
	229	Returns TRUE if the event was a left double click.
	230
	231	\membersection{wxMouseEvent::LeftDown}
	232
803ef874	233	\constfunc{bool}{LeftDown}{\void}
a660d684 KB	234
	235	Returns TRUE if the left mouse button changed to down.
	236
	237	\membersection{wxMouseEvent::LeftIsDown}
	238
803ef874	239	\constfunc{bool}{LeftIsDown}{\void}
a660d684 KB	240
	241	Returns TRUE if the left mouse button is currently down, independent
	242	of the current event type.
	243
	244	\membersection{wxMouseEvent::LeftUp}
	245
803ef874	246	\constfunc{bool}{LeftUp}{\void}
a660d684 KB	247
	248	Returns TRUE if the left mouse button changed to up.
	249
	250	\membersection{wxMouseEvent::MetaDown}
	251
803ef874	252	\constfunc{bool}{MetaDown}{\void}
a660d684 KB	253
	254	Returns TRUE if the Meta key was down at the time of the event.
	255
	256	\membersection{wxMouseEvent::MiddleDClick}
	257
803ef874	258	\constfunc{bool}{MiddleDClick}{\void}
a660d684 KB	259
	260	Returns TRUE if the event was a middle double click.
	261
	262	\membersection{wxMouseEvent::MiddleDown}
	263
803ef874	264	\constfunc{bool}{MiddleDown}{\void}
a660d684 KB	265
	266	Returns TRUE if the middle mouse button changed to down.
	267
	268	\membersection{wxMouseEvent::MiddleIsDown}
	269
803ef874	270	\constfunc{bool}{MiddleIsDown}{\void}
a660d684 KB	271
	272	Returns TRUE if the middle mouse button is currently down, independent
	273	of the current event type.
	274
	275	\membersection{wxMouseEvent::MiddleUp}
	276
803ef874	277	\constfunc{bool}{MiddleUp}{\void}
a660d684 KB	278
	279	Returns TRUE if the middle mouse button changed to up.
	280
	281	\membersection{wxMouseEvent::Moving}
	282
803ef874	283	\constfunc{bool}{Moving}{\void}
a660d684 KB	284
	285	Returns TRUE if this was a motion event (no buttons depressed).
	286
a660d684 KB	287	\membersection{wxMouseEvent::RightDClick}
a660d684 KB	288
803ef874	289	\constfunc{bool}{RightDClick}{\void}
a660d684 KB	290
	291	Returns TRUE if the event was a right double click.
	292
	293	\membersection{wxMouseEvent::RightDown}
	294
803ef874	295	\constfunc{bool}{RightDown}{\void}
a660d684 KB	296
	297	Returns TRUE if the right mouse button changed to down.
	298
	299	\membersection{wxMouseEvent::RightIsDown}
	300
803ef874	301	\constfunc{bool}{RightIsDown}{\void}
a660d684 KB	302
	303	Returns TRUE if the right mouse button is currently down, independent
	304	of the current event type.
	305
	306	\membersection{wxMouseEvent::RightUp}
	307
803ef874	308	\constfunc{bool}{RightUp}{\void}
a660d684 KB	309
	310	Returns TRUE if the right mouse button changed to up.
	311
a660d684 KB	312	\membersection{wxMouseEvent::ShiftDown}
a660d684 KB	313
803ef874	314	\constfunc{bool}{ShiftDown}{\void}
a660d684 KB	315
	316	Returns TRUE if the shift key was down at the time of the event.
	317