We surely don't need two debugging sections,

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

diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex
index ef8543a623fc8e1b2591495245bbab355818f1d6..daaafb0258ce2195154c96b7185706a294f49c1c 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.
 
 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
 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.
 
 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
 {\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}
 
 
 \wxheading{Derived from}
 


@@ -78,13 +82,13 @@ functions that take a wxKeyEvent argument.
 
 \member{bool}{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}
 
 
 \membersection{wxKeyEvent::m\_controlDown}
 
 \member{bool}{m\_controlDown}
 

-TRUE if control is pressed down.
+true if control is pressed down.

 
 \membersection{wxKeyEvent::m\_keyCode}
 
 
 \membersection{wxKeyEvent::m\_keyCode}
 


@@ -96,13 +100,13 @@ Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.
 
 \member{bool}{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}
 
 
 \membersection{wxKeyEvent::m\_shiftDown}
 
 \member{bool}{m\_shiftDown}
 

-TRUE if shift is pressed down.
+true if shift is pressed down.

 
 \membersection{wxKeyEvent::m\_x}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \membersection{wxKeyEvent::GetKeyCode}
 


@@ -150,7 +154,7 @@ 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
 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.
+{\tt\#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.

 
 \membersection{wxKeyEvent::GetRawKeyFlags}
 
 
 \membersection{wxKeyEvent::GetRawKeyFlags}
 


@@ -160,7 +164,7 @@ 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
 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.
+{\tt \#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.

 
 \membersection{wxKeyEvent::GetX}
 
 
 \membersection{wxKeyEvent::GetX}
 


@@ -178,7 +182,7 @@ Returns the Y position of the event.
 
 \constfunc{bool}{MetaDown}{\void}
 
 
 \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}
 
 
 \membersection{wxKeyEvent::GetPosition}
 


@@ -192,7 +196,7 @@ Obtains the position at which the key was pressed.
 
 \constfunc{bool}{HasModifiers}{\void}
 
 
 \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
 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


@@ -203,6 +207,5 @@ be still processed normally).
 
 \constfunc{bool}{ShiftDown}{\void}
 
 
 \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.