Document EVT_CHAR_HOOK.

Explain that it is sent to the active TLW and not the focus window and that
handling it suppresses all the normal keyboard events.

Mention that it is not generated by wxOSX/Cocoa currently, see #12431.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67190 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2011-03-14 11:54:55 +00:00
parent 982bc2e421
commit ff45048665
2 changed files with 13 additions and 0 deletions

View File

@ -1303,6 +1303,15 @@ enum wxKeyCategoryFlags
Process a @c wxEVT_KEY_UP event (any key has been released).
@event{EVT_CHAR(func)}
Process a @c wxEVT_CHAR event.
@event{EVT_CHAR_HOOK(func)}
Process a @c wxEVT_CHAR_HOOK event which is sent to the active
wxTopLevelWindow (i.e. the one containing the currently focused window)
or wxApp global object if there is no active window before any other
keyboard events are generated giving the parent window the opportunity
to intercept all the keyboard entry. If the event is handled, i.e. the
handler doesn't call wxEvent::Skip(), no further keyboard events are
generated. Notice that this event is currently not generated by
wxOSX/Cocoa port.
@endEventTable
@see wxKeyboardState

View File

@ -237,9 +237,13 @@ enum wxWindowVariant
See wxKeyEvent.
@event{EVT_KEY_UP(func)}
Process a @c wxEVT_KEY_UP event (any key has been released).
See wxKeyEvent.
@event{EVT_CHAR(func)}
Process a @c wxEVT_CHAR event.
See wxKeyEvent.
@event{EVT_CHAR_HOOK(func)}
Process a @c wxEVT_CHAR_HOOK event.
See wxKeyEvent.
@event{EVT_MOUSE_CAPTURE_LOST(func)}
Process a @c wxEVT_MOUSE_CAPTURE_LOST event. See wxMouseCaptureLostEvent.
@event{EVT_MOUSE_CAPTURE_CHANGED(func)}