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

\section{\class{wxKeyEvent}}\label{wxkeyevent}

This event class contains information about keypress (character) events.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}

\wxheading{Include files}

<wx/event.h>

\wxheading{Event table macros}

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

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event (a non-modifier key has been pressed).}
\twocolitem{{\bf EVT\_KEY\_DOWN(func)}}{Process a wxEVT\_KEY\_DOWN event (any key has been pressed).}
\twocolitem{{\bf EVT\_KEY\_UP(func)}}{Process a wxEVT\_KEY\_UP event (any key has been released).}
\twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event.}
\twocolitem{{\bf EVT\_CHAR\_HOOK(func)}}{Process a wxEVT\_CHAR\_HOOK event.}
\end{twocollist}%

\wxheading{See also}

\helpref{wxWindow::OnChar}{wxwindowonchar}, 
\helpref{wxWindow::OnCharHook}{wxwindowoncharhook}, 
\helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, 
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}

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

\membersection{wxKeyEvent::m\_altDown}

\member{bool}{m\_altDown}

TRUE if the Alt key is pressed down.

\membersection{wxKeyEvent::m\_controlDown}

\member{bool}{m\_controlDown}

TRUE if control is pressed down.

\membersection{wxKeyEvent::m\_keyCode}

\member{long}{m\_keyCode}

Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.

\membersection{wxKeyEvent::m\_metaDown}

\member{bool}{m\_metaDown}

TRUE if the Meta key is pressed down.

\membersection{wxKeyEvent::m\_shiftDown}

\member{bool}{m\_shiftDown}

TRUE if shift is pressed down.

\membersection{wxKeyEvent::m\_x}

\member{int}{m\_x}

X position of the event.

\membersection{wxKeyEvent::m\_y}

\member{int}{m\_y}

Y position of the event.

\membersection{wxKeyEvent::wxKeyEvent}

\func{}{wxKeyEvent}{\param{WXTYPE}{ keyEventType}}

Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CHAR\_HOOK.

\membersection{wxKeyEvent::AltDown}

\constfunc{bool}{AltDown}{\void}

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

\membersection{wxKeyEvent::ControlDown}

\constfunc{bool}{ControlDown}{\void}

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

\membersection{wxKeyEvent::GetKeyCode}

\constfunc{int}{GetKeyCode}{\void}

Returns the virtual key code. ASCII events return normal ASCII values,
while non-ASCII events return values such as {\bf WXK\_LEFT} for the
left cursor key. See \helpref{Keycodes}{keycodes} for a full list of the virtual key codes.

\membersection{wxKeyEvent::GetX}

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

Returns the X position of the event.

\membersection{wxKeyEvent::GetY}

\constfunc{long}{GetY}{\void}

Returns the Y position of the event.

\membersection{wxKeyEvent::MetaDown}

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

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

\membersection{wxKeyEvent::GetPosition}

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

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

Obtains the position at which the key was pressed.

\membersection{wxKeyEvent::HasModifiers}

\constfunc{bool}{HasModifiers}{\void}

Returns TRUE if either of {\sc Ctrl}, {\sc Alt} or {\sc Meta} keys was down
at the time of the key event. Note that this function does not take into
account the {\sc Shift} key state.

\membersection{wxKeyEvent::ShiftDown}

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

Returns TRUE if the shift key was down at the time of the key event.
Commit	Line	Data
a660d684 KB	1	\section{\class{wxKeyEvent}}\label{wxkeyevent}
a660d684 KB	2
4ce81a75	3	This event class contains information about keypress (character) events.
a660d684 KB	4
	5	\wxheading{Derived from}
	6
	7	\helpref{wxEvent}{wxevent}
	8
954b8ae6 JS	9	\wxheading{Include files}
	10
	11	<wx/event.h>
	12
a660d684 KB	13	\wxheading{Event table macros}
	14
	15	To process a key event, use these event handler macros to direct input to member
	16	functions that take a wxKeyEvent argument.
	17
	18	\twocolwidtha{7cm}
	19	\begin{twocollist}\itemsep=0pt
818e52c2	20	\twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event (a non-modifier key has been pressed).}
4ce81a75 JS	21	\twocolitem{{\bf EVT\_KEY\_DOWN(func)}}{Process a wxEVT\_KEY\_DOWN event (any key has been pressed).}
4ce81a75 JS	22	\twocolitem{{\bf EVT\_KEY\_UP(func)}}{Process a wxEVT\_KEY\_UP event (any key has been released).}
a660d684 KB	23	\twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event.}
	24	\twocolitem{{\bf EVT\_CHAR\_HOOK(func)}}{Process a wxEVT\_CHAR\_HOOK event.}
	25	\end{twocollist}%
	26
4ce81a75 JS	27	\wxheading{See also}
	28
	29	\helpref{wxWindow::OnChar}{wxwindowonchar},
	30	\helpref{wxWindow::OnCharHook}{wxwindowoncharhook},
	31	\helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},
	32	\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}
	33
a660d684 KB	34	\latexignore{\rtfignore{\wxheading{Members}}}
	35
	36	\membersection{wxKeyEvent::m\_altDown}
	37
	38	\member{bool}{m\_altDown}
	39
	40	TRUE if the Alt key is pressed down.
	41
	42	\membersection{wxKeyEvent::m\_controlDown}
	43
	44	\member{bool}{m\_controlDown}
	45
	46	TRUE if control is pressed down.
	47
	48	\membersection{wxKeyEvent::m\_keyCode}
	49
	50	\member{long}{m\_keyCode}
	51
3972fb49	52	Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.
a660d684 KB	53
	54	\membersection{wxKeyEvent::m\_metaDown}
	55
	56	\member{bool}{m\_metaDown}
	57
	58	TRUE if the Meta key is pressed down.
	59
	60	\membersection{wxKeyEvent::m\_shiftDown}
	61
	62	\member{bool}{m\_shiftDown}
	63
	64	TRUE if shift is pressed down.
	65
	66	\membersection{wxKeyEvent::m\_x}
	67
	68	\member{int}{m\_x}
	69
	70	X position of the event.
	71
	72	\membersection{wxKeyEvent::m\_y}
	73
	74	\member{int}{m\_y}
	75
	76	Y position of the event.
	77
	78	\membersection{wxKeyEvent::wxKeyEvent}
	79
	80	\func{}{wxKeyEvent}{\param{WXTYPE}{ keyEventType}}
	81
	82	Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CHAR\_HOOK.
	83
	84	\membersection{wxKeyEvent::AltDown}
	85
803ef874	86	\constfunc{bool}{AltDown}{\void}
a660d684 KB	87
	88	Returns TRUE if the Alt key was down at the time of the key event.
	89
	90	\membersection{wxKeyEvent::ControlDown}
	91
803ef874	92	\constfunc{bool}{ControlDown}{\void}
a660d684 KB	93
	94	Returns TRUE if the control key was down at the time of the key event.
	95
f6bcfd97 BP	96	\membersection{wxKeyEvent::GetKeyCode}
	97
	98	\constfunc{int}{GetKeyCode}{\void}
	99
	100	Returns the virtual key code. ASCII events return normal ASCII values,
	101	while non-ASCII events return values such as {\bf WXK\_LEFT} for the
	102	left cursor key. See \helpref{Keycodes}{keycodes} for a full list of the virtual key codes.
	103
a660d684 KB	104	\membersection{wxKeyEvent::GetX}
a660d684 KB	105
803ef874	106	\constfunc{long}{GetX}{\void}
a660d684 KB	107
	108	Returns the X position of the event.
	109
	110	\membersection{wxKeyEvent::GetY}
	111
803ef874	112	\constfunc{long}{GetY}{\void}
a660d684 KB	113
	114	Returns the Y position of the event.
	115
a660d684 KB	116	\membersection{wxKeyEvent::MetaDown}
a660d684 KB	117
803ef874	118	\constfunc{bool}{MetaDown}{\void}
a660d684 KB	119
	120	Returns TRUE if the Meta key was down at the time of the key event.
	121
803ef874	122	\membersection{wxKeyEvent::GetPosition}
a660d684	123
803ef874 JS	124	\constfunc{wxPoint}{GetPosition}{\void}
	125
	126	\constfunc{void}{GetPosition}{\param{long }{x}, \param{long }{y}}
a660d684 KB	127
	128	Obtains the position at which the key was pressed.
	129
f6bcfd97 BP	130	\membersection{wxKeyEvent::HasModifiers}
	131
	132	\constfunc{bool}{HasModifiers}{\void}
	133
	134	Returns TRUE if either of {\sc Ctrl}, {\sc Alt} or {\sc Meta} keys was down
	135	at the time of the key event. Note that this function does not take into
	136	account the {\sc Shift} key state.
	137
a660d684 KB	138	\membersection{wxKeyEvent::ShiftDown}
a660d684 KB	139
803ef874	140	\constfunc{bool}{ShiftDown}{\void}
a660d684 KB	141
	142	Returns TRUE if the shift key was down at the time of the key event.
	143
	144