diff options
| author | Bartlomiej Moskal <bartlomiej.moskal@qt.io> | 2023-07-04 14:27:05 +0200 |
|---|---|---|
| committer | Bartlomiej Moskal <bartlomiej.moskal@qt.io> | 2023-07-13 06:14:09 +0000 |
| commit | 1ca4bb63477f8b15f99780815325334d552acbdb (patch) | |
| tree | 1166498984c39d66f85e4418dfd1456a4c7e6c32 /src/quick/items/qquicktextinput.cpp | |
| parent | b5a4e168c30f745d95f38fc3c641219737afd68a (diff) | |
Doc: add information about preeditText in text property
The documentation for the TextEdit::text and TextInput::text properties
was missing information about preeditText. This may result in the
expectation that text property will always contain all displayed text.
Pick-to: 6.6 6.5 6.2
Fixes: QTBUG-109306
Change-Id: Ifa0b214238633a42e9772f796547f776a0d4251c
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
Diffstat (limited to 'src/quick/items/qquicktextinput.cpp')
| -rw-r--r-- | src/quick/items/qquicktextinput.cpp | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/src/quick/items/qquicktextinput.cpp b/src/quick/items/qquicktextinput.cpp index 0a63a21add..22db97b96c 100644 --- a/src/quick/items/qquicktextinput.cpp +++ b/src/quick/items/qquicktextinput.cpp @@ -90,7 +90,13 @@ void QQuickTextInput::componentComplete() The text in the TextInput. - \sa clear() + Note that some keyboards use a predictive function. In this case, + the text being composed by the input method is not part of this property. + The part of the text related to the predictions is underlined and stored in + the \l preeditText property. To get whole text displayed in the TextInput + use \l displayText property. + + \sa clear(), displayText, preeditText */ QString QQuickTextInput::text() const { @@ -2410,7 +2416,10 @@ QString QQuickTextInput::displayText() const This property contains partial text input from an input method. - \sa displayText + To turn off partial text that results from predictions, set the \c Qt.ImhNoPredictiveText + flag in inputMethodHints. + + \sa displayText, inputMethodHints */ QString QQuickTextInput::preeditText() const { |