diff options
| author | aavit <qt_aavit@ovi.com> | 2012-09-05 11:34:16 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-09-05 21:06:05 +0200 |
| commit | aba8de1bee8bbb9bc6b92e761a3dda0d829a211e (patch) | |
| tree | 729812214c932c677de1d08000799828924c6da6 /src/gui/kernel/qinputmethod.cpp | |
| parent | 49112c891bb84eee4083fdad4376cba60b0c7818 (diff) | |
Doc: Missing documentation added and doc errors fixed.
Change-Id: I573bf9622e38b54f2cb8c32fd402d477a1deb5c2
Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org>
Reviewed-by: Kim M. Kalland <kim.kalland@nokia.com>
Diffstat (limited to 'src/gui/kernel/qinputmethod.cpp')
| -rw-r--r-- | src/gui/kernel/qinputmethod.cpp | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/src/gui/kernel/qinputmethod.cpp b/src/gui/kernel/qinputmethod.cpp index ec2c3ed48c..5cb36f21c7 100644 --- a/src/gui/kernel/qinputmethod.cpp +++ b/src/gui/kernel/qinputmethod.cpp @@ -121,7 +121,7 @@ QTransform QInputMethod::inputItemTransform() const } /*! - Sets the transformation from input item coordinates to the window coordinates. + Sets the transformation from input item coordinates to window coordinates to be \a transform. Item transform needs to be updated by the focused window like QQuickCanvas whenever item is moved inside the scene. */ @@ -230,7 +230,8 @@ bool QInputMethod::isVisible() const /*! Controls the keyboard visibility. Equivalent - to calling show() and hide() functions. + to calling show() (if \a visible is \c true) + or hide() (if \a visible is \c false). \sa show(), hide() */ @@ -345,9 +346,20 @@ void QInputMethod::commit() } /*! + \enum QInputMethod::Action + + Indicates the kind of action performed by the user. + + \value Click A normal click/tap + \value ContextMenu A context menu click/tap (e.g. right-button or tap-and-hold) + + \sa invokeAction() +*/ + +/*! Called by the input item when the word currently being composed is tapped by - the user. Input methods often use this information to offer more word - suggestions to the user. + the user, as indicated by the action \a a and the given \a cursorPosition. + Input methods often use this information to offer more word suggestions to the user. */ void QInputMethod::invokeAction(Action a, int cursorPosition) { |