\section{\class{wxKeyEvent}}\label{wxkeyevent}
-This event class contains information about keypress (character) events. See \helpref{wxWindow::OnChar}{wxwindowonchar}.
+This event class contains information about keypress (character) events.
+
+Notice that there are three different kinds of keyboard events in wxWidgets:
+key down and up events and char events. The difference between the first two
+is clear - the first corresponds to a key press and the second to a key
+release - otherwise they are identical. Just note that if the key is
+maintained in a pressed state you will typically get a lot of (automatically
+generated) down events but only one up so it is wrong to assume that there is
+one up event corresponding to each down one.
+
+Both key events provide untranslated key codes while the char event carries
+the translated one. The untranslated code for alphanumeric keys is always
+an upper case value. For the other keys it is one of {\tt WXK\_XXX} values
+from the \helpref{keycodes table}{keycodes}. The translated key is, in
+general, the character the user expects to appear as the result of the key
+combination when typing the text into a text entry zone, for example.
+
+A few examples to clarify this (all assume that {\sc Caps Lock} is unpressed
+and the standard US keyboard): when the {\tt 'A'} key is pressed, the key down
+event key code is equal to {\tt ASCII A} $== 65$. But the char event key code
+is {\tt ASCII a} $== 97$. On the other hand, if you press both {\sc Shift} and
+{\tt 'A'} keys simultaneously , the key code in key down event will still be
+just {\tt 'A'} while the char event key code parameter will now be {\tt 'A'}
+as well.
+
+Although in this simple case it is clear that the correct key code could be
+found in the key down event handler by checking the value returned by
+\helpref{ShiftDown()}{wxkeyeventshiftdown}, in general you should use
+{\tt EVT\_CHAR} for this as for non alphanumeric keys the translation is
+keyboard-layout dependent and can only be done properly by the system itself.
+
+Another kind of translation is done when the control key is pressed: for
+example, for {\sc Ctrl-A} key press the key down event still carries the
+same key code {\tt 'a'} as usual but the char event will have key code of
+$1$, the ASCII value of this key combination.
+
+You may discover how the other keys on your system behave interactively by
+running the \helpref{text}{sampletext} wxWidgets sample and pressing some keys
+in any of the text controls shown in it.
+
+{\bf Note:} If a key down ({\tt EVT\_KEY\_DOWN}) event is caught and
+the event handler does not call {\tt event.Skip()} then the coresponding
+char event ({\tt EVT\_CHAR}) will not happen. This is by design and
+enables the programs that handle both types of events to be a bit
+simpler.
+
+{\bf Note for Windows programmers:} The key and char events in wxWidgets are
+similar to but slightly different from Windows {\tt WM\_KEYDOWN} and
+{\tt WM\_CHAR} events. In particular, Alt-x combination will generate a char
+event in wxWidgets (unless it is used as an accelerator).
+
+{\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in
+key event function, otherwise menu shortcuts may cease to work under Windows.
\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
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
+\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.}
+%\twocolitem{{\bf EVT\_CHAR\_HOOK(func)}}{Process a wxEVT\_CHAR\_HOOK event.}
\end{twocollist}%
+
\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxKeyEvent::m\_altDown}
\member{bool}{m\_altDown}
-TRUE if the Alt key is pressed down.
+true if the Alt key is pressed down.
+
\membersection{wxKeyEvent::m\_controlDown}
\member{bool}{m\_controlDown}
-TRUE if control is pressed down.
+true if control is pressed down.
+
\membersection{wxKeyEvent::m\_keyCode}
\member{long}{m\_keyCode}
-Virtual keycode. An enumerated type, one of:
-
-\begin{verbatim}
- WXK_BACK = 8
- WXK_TAB = 9
- WXK_RETURN = 13
- WXK_ESCAPE = 27
- WXK_SPACE = 32
- WXK_DELETE = 127
-
- WXK_START = 300
- WXK_LBUTTON
- WXK_RBUTTON
- WXK_CANCEL
- WXK_MBUTTON
- WXK_CLEAR
- WXK_SHIFT
- WXK_CONTROL
- WXK_MENU
- WXK_PAUSE
- WXK_CAPITAL
- WXK_PRIOR
- WXK_NEXT
- WXK_END
- WXK_HOME
- WXK_LEFT
- WXK_UP
- WXK_RIGHT
- WXK_DOWN
- WXK_SELECT
- WXK_PRINT
- WXK_EXECUTE
- WXK_SNAPSHOT
- WXK_INSERT
- WXK_HELP
- WXK_NUMPAD0
- WXK_NUMPAD1
- WXK_NUMPAD2
- WXK_NUMPAD3
- WXK_NUMPAD4
- WXK_NUMPAD5
- WXK_NUMPAD6
- WXK_NUMPAD7
- WXK_NUMPAD8
- WXK_NUMPAD9
- WXK_MULTIPLY
- WXK_ADD
- WXK_SEPARATOR
- WXK_SUBTRACT
- WXK_DECIMAL
- WXK_DIVIDE
- WXK_F1
- WXK_F2
- WXK_F3
- WXK_F4
- WXK_F5
- WXK_F6
- WXK_F7
- WXK_F8
- WXK_F9
- WXK_F10
- WXK_F11
- WXK_F12
- WXK_F13
- WXK_F14
- WXK_F15
- WXK_F16
- WXK_F17
- WXK_F18
- WXK_F19
- WXK_F20
- WXK_F21
- WXK_F22
- WXK_F23
- WXK_F24
- WXK_NUMLOCK
- WXK_SCROLL
-\end{verbatim}
+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.
+true if the Meta key is pressed down.
+
\membersection{wxKeyEvent::m\_shiftDown}
\member{bool}{m\_shiftDown}
-TRUE if shift is pressed down.
+true if shift is pressed down.
+
\membersection{wxKeyEvent::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}
-\func{bool}{AltDown}{\void}
+\constfunc{bool}{AltDown}{\void}
-Returns TRUE if the Alt key was down at the time of the key event.
+Returns true if the Alt key was down at the time of the key event.
-\membersection{wxKeyEvent::ControlDown}
-\func{bool}{ControlDown}{\void}
+\membersection{wxKeyEvent::CmdDown}\label{wxkeyeventcmddown}
-Returns TRUE if the control key was down at the time of the key event.
+\constfunc{bool}{CmdDown}{\void}
-\membersection{wxKeyEvent::GetX}
+"Cmd" is a pseudo key which is the same as Control for PC and Unix platforms
+but the special "Apple" (a.k.a as "Command") key under Macs: it makes often
+sense to use it instead of, say, ControlDown() because Cmd key is used for the
+same thing under Mac as Ctrl elsewhere (but Ctrl still exists, just not used
+for this purpose under Mac). So for non-Mac platforms this is the same as
+\helpref{ControlDown()}{wxkeyeventcontroldown} and under Mac this is the same
+as \helpref{MetaDown()}{wxkeyeventmetadown}.
-\func{float}{GetX}{\void}
-Returns the X position of the event.
+\membersection{wxKeyEvent::ControlDown}\label{wxkeyeventcontroldown}
-\membersection{wxKeyEvent::GetY}
+\constfunc{bool}{ControlDown}{\void}
-\func{float}{GetY}{\void}
+Returns true if the control key was down at the time of the key event.
-Returns the Y position of the event.
-\membersection{wxKeyEvent::KeyCode}
+\membersection{wxKeyEvent::GetKeyCode}
-\func{long}{KeyCode}{\void}
+\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 {\tt wx\_defs.h} for a full list of the virtual key codes.
+left cursor key. See \helpref{Keycodes}{keycodes} for a full list of the virtual key codes.
+
+
+\membersection{wxKeyEvent::GetPosition}
+
+\constfunc{wxPoint}{GetPosition}{\void}
+
+\constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
+
+Obtains the position (in client coordinates) at which the key was pressed.
+
+
+\membersection{wxKeyEvent::GetRawKeyCode}
+
+\constfunc{wxUint32}{GetRawKeyCode}{\void}
+
+Returns the raw key code for this event. This is a platform-dependent scan code
+which should only be used in advanced applications.
+
+{\bf NB:} Currently the raw key codes are not supported by all ports, use
+{\tt\#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
+
+
+\membersection{wxKeyEvent::GetRawKeyFlags}
+
+\constfunc{wxUint32}{GetRawKeyFlags}{\void}
+
+Returns the low level key flags for this event. The flags are
+platform-dependent and should only be used in advanced applications.
+
+{\bf NB:} Currently the raw key flags are not supported by all ports, use
+{\tt \#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
+
+
+\membersection{wxKeyEvent::GetUnicodeKey}
+
+\constfunc{wxChar}{GetUnicodeKey}{\void}
+
+Returns the Unicode character corresponding to this key event.
+
+This function is only available in Unicode build, i.e. when
+\texttt{wxUSE\_UNICODE} is $1$.
+
+
+\membersection{wxKeyEvent::GetX}
+
+\constfunc{long}{GetX}{\void}
+
+Returns the X position (in client coordinates) of the event.
+
+
+\membersection{wxKeyEvent::GetY}
+
+\constfunc{long}{GetY}{\void}
+
+Returns the Y (in client coordinates) position of the event.
+
+
+\membersection{wxKeyEvent::HasModifiers}
-\membersection{wxKeyEvent::MetaDown}
+\constfunc{bool}{HasModifiers}{\void}
-\func{bool}{MetaDown}{\void}
+Returns true if either {\sc Ctrl} or {\sc Alt} keys was down
+at the time of the key event. Note that this function does not take into
+account neither {\sc Shift} nor {\sc Meta} key states (the reason for ignoring
+the latter is that it is common for {\sc NumLock} key to be configured as
+{\sc Meta} under X but the key presses even while {\sc NumLock} is on should
+be still processed normally).
-Returns TRUE if the Meta key was down at the time of the key event.
-\membersection{wxKeyEvent::Position}
+\membersection{wxKeyEvent::MetaDown}\label{wxkeyeventmetadown}
-\func{void}{Position}{\param{float *}{x}, \param{float *}{y}}
+\constfunc{bool}{MetaDown}{\void}
-Obtains the position at which the key was pressed.
+Returns true if the Meta key was down at the time of the key event.
-\membersection{wxKeyEvent::ShiftDown}
-\func{bool}{ShiftDown}{\void}
+\membersection{wxKeyEvent::ShiftDown}\label{wxkeyeventshiftdown}
-Returns TRUE if the shift key was down at the time of the key event.
+\constfunc{bool}{ShiftDown}{\void}
+Returns true if the shift key was down at the time of the key event.
projects / wxWidgets.git / blobdiff