aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items/qquicktextedit.cpp
diff options
context:
space:
mode:
authorBartlomiej Moskal <bartlomiej.moskal@qt.io>2023-07-04 14:27:05 +0200
committerBartlomiej Moskal <bartlomiej.moskal@qt.io>2023-07-13 06:14:09 +0000
commit1ca4bb63477f8b15f99780815325334d552acbdb (patch)
tree1166498984c39d66f85e4418dfd1456a4c7e6c32 /src/quick/items/qquicktextedit.cpp
parentb5a4e168c30f745d95f38fc3c641219737afd68a (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/qquicktextedit.cpp')
-rw-r--r--src/quick/items/qquicktextedit.cpp12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/quick/items/qquicktextedit.cpp b/src/quick/items/qquicktextedit.cpp
index 6388501e8e..301547eb3b 100644
--- a/src/quick/items/qquicktextedit.cpp
+++ b/src/quick/items/qquicktextedit.cpp
@@ -370,7 +370,12 @@ QString QQuickTextEdit::text() const
remarkably better performance for modifying especially large rich text
content.
- \sa clear(), textFormat
+ 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.
+
+ \sa clear(), preeditText, textFormat
*/
void QQuickTextEdit::setText(const QString &text)
{
@@ -420,6 +425,11 @@ void QQuickTextEdit::q_invalidate()
\since 5.7
This property contains partial text input from an input method.
+
+ To turn off partial text that results from predictions, set the \c Qt.ImhNoPredictiveText
+ flag in inputMethodHints.
+
+ \sa inputMethodHints
*/
QString QQuickTextEdit::preeditText() const
{