Explaining details in QKeyEvent consruktor signature

Explained the role of the key attribute.

Task-number:246839
Rev-by: Richard Moe Gustavsen

1 files changed, 7 insertions, 6 deletions

diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index 8c7e47d..2aed287 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -675,12 +675,13 @@ QWheelEvent::QWheelEvent(const QPoint &pos, const QPoint& globalPos, int delta,
     The \a type parameter must be QEvent::KeyPress, QEvent::KeyRelease,
     or QEvent::ShortcutOverride.
 
-    If \a key is 0, the event is not a result of
-    a known key; for example, it may be the result of a compose
-    sequence or keyboard macro. The \a modifiers holds the keyboard
-    modifiers, and the given \a text is the Unicode text that the
-    key generated. If \a autorep is true, isAutoRepeat() will be
-    true. \a count is the number of keys involved in the event.
+    Int \a key is the code for the Qt::Key that the event loop should listen 
+    for. If \a key is 0, the event is not a result of a known key; for 
+    example, it may be the result of a compose sequence or keyboard macro.
+    The \a modifiers holds the keyboard modifiers, and the given \a text 
+    is the Unicode text that the key generated. If \a autorep is true, 
+    isAutoRepeat() will be true. \a count is the number of keys involved 
+    in the event.
 */
 QKeyEvent::QKeyEvent(Type type, int key, Qt::KeyboardModifiers modifiers, const QString& text,
                      bool autorep, ushort count)