summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@digia.com>2013-04-24 13:32:11 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-04-30 15:11:23 +0200
commitc56372e379c8aae5e61badce1eaae2f7c3dfc2d5 (patch)
tree3f901a54b2da0fb352393570b2bd0235934c4df8 /src
parent299154bd652a70c4ff90f2b2d08c1939cafe2df0 (diff)
Clarify documentation for QKeyEvent::text
Change-Id: I4b455a512b2e678b6127ea488b456c68eb80cdbc Reviewed-by: hjk <hjk121@nokiamail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/gui/kernel/qevent.cpp13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index c5be379b7d..ba97db4d39 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -947,11 +947,14 @@ QKeyEvent::~QKeyEvent()
/*!
\fn QString QKeyEvent::text() const
- Returns the Unicode text that this key generated. The text
- returned can be an empty string in cases
- where modifier keys, such as Shift, Control, Alt, and Meta,
- are being pressed or released. In such cases key() will contain
- a valid value.
+ Returns the Unicode text that this key generated.
+
+ Return values when modifier keys such as
+ Shift, Control, Alt, and Meta are pressed
+ differ among platforms and could return an empty string.
+
+ \note \l key() will always return a valid value,
+ independent of modifier keys.
\sa Qt::WA_KeyCompression
*/