Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65241 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2010-08-10 22:39:00 +00:00
parent 276f883f7a
commit 0d2f3b9d7b
2 changed files with 41 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/doxygen/mainpages/samples.h
View File

@@ -555,6 +555,12 @@ its directory. Please also see the @ref overview_i18n.
@sampleabout{wxKeyEvent} @sampleabout{wxKeyEvent}
This sample can be used to interactively test the events produced by pressing
various keyboard keys. It also shows the interaction between accelerators and
the normal keyboard events (which are overridden by any defined accelerators)
and finally allows to test that not skipping an event in EVT_KEY_DOWN handler
suppresses the subsequent EVT_CHAR event.
@sampledir{keyboard} @sampledir{keyboard}
@section page_samples_layout Layout Sample @section page_samples_layout Layout Sample

54
interface/wx/event.h
View File

@@ -1179,7 +1179,7 @@ enum wxKeyCategoryFlags
/** /**
@class wxKeyEvent @class wxKeyEvent
This event class contains information about keypress (character) events. This event class contains information about key press and release events.
Notice that there are three different kinds of keyboard events in wxWidgets: 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 key down and up events and char events. The difference between the first two
@@ -1189,13 +1189,12 @@ enum wxKeyCategoryFlags
generated) down events but only one up 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. one up event corresponding to each down one.
Both key events provide untranslated key codes while the char event carries Both key down and up events provide untranslated key codes while the char
the translated one. The untranslated code for alphanumeric keys is always event carries the translated one. The untranslated code for alphanumeric
an upper case value. For the other keys it is one of @c WXK_XXX values keys is always an upper case value. For the other keys it is one of @c
from the ::wxKeyCode enumeration. WXK_XXX values from the ::wxKeyCode enumeration. The translated key is, in
The translated key is, in general, the character the user expects to appear general, the character the user expects to appear as the result of the key
as the result of the key combination when typing the text into a text entry combination when typing the text into a text entry zone, for example.
zone, for example.
A few examples to clarify this (all assume that CAPS LOCK is unpressed A few examples to clarify this (all assume that CAPS LOCK is unpressed
and the standard US keyboard): when the @c 'A' key is pressed, the key down and the standard US keyboard): when the @c 'A' key is pressed, the key down
@@ -1207,18 +1206,29 @@ enum wxKeyCategoryFlags
Although in this simple case it is clear that the correct key code could be 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 found in the key down event handler by checking the value returned by
wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR for this as wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR if you need
for non-alphanumeric keys the translation is keyboard-layout dependent and the translated key as for non-alphanumeric keys the translation is
can only be done properly by the system itself. 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 Another kind of translation is done when the control key is pressed: for
example, for CTRL-A key press the key down event still carries the example, for CTRL-A key press the key down event still carries the
same key code @c 'a' as usual but the char event will have key code of 1, same key code @c 'a' as usual but the char event will have key code of 1,
the ASCII value of this key combination. the ASCII value of this key combination.
Notice that while pressing any key will generate a key down event (except
in presence of IME perhaps) a few special keys don't generate a char event:
currently, Shift, Control (or Command), Alt (or Menu or Meta) and Caps, Num
and Scroll Lock keys don't do it. For all the other keys you have the
choice about whether to choose key down or char event for handling it and
either can be used. However it is advised to use char events only for the
keys that are supposed to generate characters on screen and key down events
for all the rest.
You may discover how the other keys on your system behave interactively by You may discover how the other keys on your system behave interactively by
running the @ref page_samples_text wxWidgets sample and pressing some keys running the @ref page_samples_keyboard wxWidgets sample and pressing some
in any of the text controls shown in it. keys in it.
@b Tip: be sure to call @c event.Skip() for events that you don't process in @b Tip: be sure to call @c event.Skip() for events that you don't process in
key event function, otherwise menu shortcuts may cease to work under Windows. key event function, otherwise menu shortcuts may cease to work under Windows.
@@ -1232,7 +1242,9 @@ enum wxKeyCategoryFlags
@note For Windows programmers: The key and char events in wxWidgets are @note For Windows programmers: The key and char events in wxWidgets are
similar to but slightly different from Windows @c WM_KEYDOWN and similar to but slightly different from Windows @c WM_KEYDOWN and
@c WM_CHAR events. In particular, Alt-x combination will generate a @c WM_CHAR events. In particular, Alt-x combination will generate a
char event in wxWidgets (unless it is used as an accelerator). char event in wxWidgets (unless it is used as an accelerator) and
almost all keys, including ones without ASCII equivalents, generate
char events too.
@beginEventTable{wxKeyEvent} @beginEventTable{wxKeyEvent}
@@ -1261,12 +1273,13 @@ public:
/** /**
Returns the virtual key code. ASCII events return normal ASCII values, Returns the virtual key code. ASCII events return normal ASCII values,
while non-ASCII events return values such as @b WXK_LEFT for the left cursor while non-ASCII events return values such as @b WXK_LEFT for the left
key. See ::wxKeyCode for a full list of the virtual key codes. cursor key. See ::wxKeyCode for a full list of the virtual key codes.
Note that in Unicode build, the returned value is meaningful only if the Note that in Unicode build, the returned value is meaningful only if
user entered a character that can be represented in current locale's default the user entered a character that can be represented in current
charset. You can obtain the corresponding Unicode character using GetUnicodeKey(). locale's default charset. You can obtain the corresponding Unicode
character using GetUnicodeKey().
*/ */
int GetKeyCode() const; int GetKeyCode() const;
@@ -1309,6 +1322,9 @@ public:
/** /**
Returns the Unicode character corresponding to this key event. Returns the Unicode character corresponding to this key event.
If the key pressed doesn't have any character value (e.g. a cursor key)
this method will return 0.
This function is only available in Unicode build, i.e. when This function is only available in Unicode build, i.e. when
@c wxUSE_UNICODE is 1. @c wxUSE_UNICODE is 1.
*/ */