Doc: Extend description of ShortcutOverride event

Better late than never.

Task-number: QTBUG-533
Change-Id: Ieb68d510f75553a6aa0a6e9046c11e3a34b8815f
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>

1 files changed, 6 insertions, 0 deletions

diff --git a/src/corelib/kernel/qcoreevent.cpp b/src/corelib/kernel/qcoreevent.cpp
index 58ca8279ea..3d0a9dd05d 100644
--- a/src/corelib/kernel/qcoreevent.cpp
+++ b/src/corelib/kernel/qcoreevent.cpp
@@ -202,6 +202,12 @@ QT_BEGIN_NAMESPACE
     \value Scroll                           The object needs to scroll to the supplied position (QScrollEvent).
     \value Shortcut                         Key press in child for shortcut key handling (QShortcutEvent).
     \value ShortcutOverride                 Key press in child, for overriding shortcut key handling (QKeyEvent).
+                                            When a shortcut is about to trigger, \c ShortcutOverride
+                                            is sent to the active window. This allows clients (e.g. widgets)
+                                            to signal that they will handle the shortcut themselves, by
+                                            accepting the event. If the shortcut override is accepted, the
+                                            event is delivered as a normal key press to the focus widget.
+                                            Otherwise, it triggers the shortcut action, if one exists.
     \value Show                             Widget was shown on screen (QShowEvent).
     \value ShowToParent                     A child widget has been shown.
     \value SockAct                          Socket activated, used to implement QSocketNotifier.