Fixed problem with Calltip tab not refreshing properly on Windows.

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

diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex
index 8f78c1a23c663e143ba0704f0e71081444024af3..e2b47c7fb8017efa47bdc069c01afa82b84fe168 100644 (file)
--- a/docs/latex/wx/keyevent.tex
+++ b/docs/latex/wx/keyevent.tex
@@ -17,11 +17,6 @@ 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
@@ -45,10 +40,19 @@ You may discover how the other keys on your system behave interactively by
 running the \helpref{text}{sampletext} wxWindows 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 wxWindows 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 wxWindows (unless it is used as an acclerator).
+event in wxWindows (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}
 
@@ -78,13 +82,13 @@ functions that take a wxKeyEvent argument.
 
 \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}
 
@@ -96,13 +100,13 @@ Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.
 
 \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}
 
@@ -126,13 +130,13 @@ Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CH
 
 \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}
 
 \constfunc{bool}{ControlDown}{\void}
 
-Returns TRUE if the control key was down at the time of the key event.
+Returns true if the control key was down at the time of the key event.
 
 \membersection{wxKeyEvent::GetKeyCode}
 
@@ -142,23 +146,43 @@ 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}
 
-Returns the X position of the event.
+Returns the X position (in client coordinates) of the event.
 
 \membersection{wxKeyEvent::GetY}
 
 \constfunc{long}{GetY}{\void}
 
-Returns the Y position of the event.
+Returns the Y (in client coordinates) 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.
+Returns true if the Meta key was down at the time of the key event.
 
 \membersection{wxKeyEvent::GetPosition}
 
@@ -166,13 +190,13 @@ Returns TRUE if the Meta key was down at the time of the key event.
 
 \constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
 
-Obtains the position at which the key was pressed.
+Obtains the position (in client coordinates) at which the key was pressed.
 
 \membersection{wxKeyEvent::HasModifiers}
 
 \constfunc{bool}{HasModifiers}{\void}
 
-Returns TRUE if either {\sc Ctrl} or {\sc Alt} keys was down
+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
@@ -183,6 +207,5 @@ be still processed normally).
 
 \constfunc{bool}{ShiftDown}{\void}
 
-Returns TRUE if the shift key was down at the time of the key event.
-
+Returns true if the shift key was down at the time of the key event.