From ff4504866553ba7672efd8efa9f6120af18fc5ec Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 14 Mar 2011 11:54:55 +0000 Subject: [PATCH] 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 --- interface/wx/event.h | 9 +++++++++ interface/wx/window.h | 4 ++++ 2 files changed, 13 insertions(+) diff --git a/interface/wx/event.h b/interface/wx/event.h index 9e5bb81323..863ee56c23 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -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 diff --git a/interface/wx/window.h b/interface/wx/window.h index 4fe83f8585..0a3043e994 100644 --- a/interface/wx/window.h +++ b/interface/wx/window.h @@ -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)} -- 2.45.2