X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f17393f19902b4fd15ad20068af37aa6bbefd952..ebb396715d5ecd865a225fa3cf7675277ceb3f1b:/docs/latex/wx/keyevent.tex

diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex
index 0abdc667d4..bd8174736c 100644
--- a/docs/latex/wx/keyevent.tex
+++ b/docs/latex/wx/keyevent.tex
@@ -7,7 +7,7 @@ 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 up one so it is wrong to assume that there is
+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
@@ -17,17 +17,22 @@ 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.
 
+If the key up event is caught and the event handler does not call
+event.Skip() then the coresponding char event will not happen.  This
+is by design and enables the programs that handle both types of events
+to be a bit simpler.
+
 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'} 
+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 
+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.
 
@@ -41,10 +46,13 @@ running the \helpref{text}{sampletext} wxWindows sample and pressing some keys
 in any of the text controls shown in it.
 
 {\bf Note for Windows programmers:} The key and char events in wxWindows are
-similar to but slightly different from Windows {\tt WM\_KEYDOWN} and 
+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 wxWindows (unless it is used as an acclerator).
 
+{\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}
@@ -66,12 +74,6 @@ functions that take a wxKeyEvent argument.
 %\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}}}
 
@@ -143,6 +145,26 @@ 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::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::GetX}
 
 \constfunc{long}{GetX}{\void}
@@ -176,7 +198,7 @@ Obtains the position at which the key was pressed.
 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 
+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).
 
@@ -186,4 +208,3 @@ be still processed normally).
 
 Returns TRUE if the shift key was down at the time of the key event.
 
-