Add TextInput::textEdited()

[ChangeLog][QtQuick][TextInput] Added textEdited() signal to
distinguish user edits from programmatical text changes.

Change-Id: I1d78499e3e11f9f1cab80ce3b0a6d9f2713219f4
Task-number: QTBUG-57203
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

4 files changed, 68 insertions, 1 deletions

diff --git a/src/quick/items/qquickitemsmodule.cpp b/src/quick/items/qquickitemsmodule.cpp
index b8db5d76e4..ee7b566266 100644
--- a/src/quick/items/qquickitemsmodule.cpp
+++ b/src/quick/items/qquickitemsmodule.cpp
@@ -376,6 +376,7 @@ static void qt_quickitems_defineModule(const char *uri, int major, int minor)
 
     qmlRegisterType<QQuickFlickable, 9>(uri, 2, 9, "Flickable");
     qmlRegisterType<QQuickMouseArea, 9>(uri, 2, 9, "MouseArea");
+    qmlRegisterType<QQuickTextInput, 9>(uri, 2, 9, "TextInput");
 }
 
 static void initResources()
diff --git a/src/quick/items/qquicktextinput.cpp b/src/quick/items/qquicktextinput.cpp
index 27f3dcecfa..e9f88ae7f0 100644
--- a/src/quick/items/qquicktextinput.cpp
+++ b/src/quick/items/qquicktextinput.cpp
@@ -1152,6 +1152,17 @@ bool QQuickTextInput::hasAcceptableInput() const
     The corresponding handler is \c onEditingFinished.
 */
 
+/*!
+    \qmlsignal QtQuick::TextInput::textEdited()
+    \since 5.9
+
+    This signal is emitted whenever the text is edited. Unlike \c textChanged(),
+    this signal is not emitted when the text is changed programmatically, for example,
+    by changing the value of the \c text property or by calling \c clear().
+
+    The corresponding handler is \c onTextEdited.
+*/
+
 #if QT_CONFIG(im)
 Qt::InputMethodHints QQuickTextInputPrivate::effectiveInputMethodHints() const
 {
@@ -3499,7 +3510,7 @@ void QQuickTextInputPrivate::selectWordAtPos(int cursor)
 
     The \a update value is currently unused.
 */
-bool QQuickTextInputPrivate::finishChange(int validateFromState, bool update, bool /*edited*/)
+bool QQuickTextInputPrivate::finishChange(int validateFromState, bool update, bool edited)
 {
     Q_Q(QQuickTextInput);
 
@@ -3570,6 +3581,8 @@ bool QQuickTextInputPrivate::finishChange(int validateFromState, bool update, bo
             m_preeditDirty = false;
 #endif
             alignmentChanged = determineHorizontalAlignment();
+            if (edited)
+                emit q->textEdited();
             emit q->textChanged();
         }
 
diff --git a/src/quick/items/qquicktextinput_p.h b/src/quick/items/qquicktextinput_p.h
index f4545e1574..c4da807471 100644
--- a/src/quick/items/qquicktextinput_p.h
+++ b/src/quick/items/qquicktextinput_p.h
@@ -319,6 +319,7 @@ Q_SIGNALS:
     void accepted();
     void acceptableInputChanged();
     Q_REVISION(2) void editingFinished();
+    Q_REVISION(9) void textEdited();
     void colorChanged();
     void selectionColorChanged();
     void selectedTextColorChanged();
diff --git a/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp b/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp
index 1451f8e2fc..67921e1fd0 100644
--- a/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp
+++ b/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp
@@ -135,6 +135,7 @@ private slots:
 
     void signal_accepted();
     void signal_editingfinished();
+    void signal_textEdited();
 
     void passwordCharacter();
     void cursorDelegate_data();
@@ -2441,6 +2442,57 @@ void tst_qquicktextinput::signal_editingfinished()
     QTRY_COMPARE(editingFinished2Spy.count(), 1);
 }
 
+void tst_qquicktextinput::signal_textEdited()
+{
+    QQuickWindow window;
+    window.show();
+    window.requestActivate();
+    QTest::qWaitForWindowActive(&window);
+
+    QQuickTextInput *input = new QQuickTextInput(window.contentItem());
+    QVERIFY(input);
+
+    QSignalSpy textChangedSpy(input, SIGNAL(textChanged()));
+    QVERIFY(textChangedSpy.isValid());
+
+    QSignalSpy textEditedSpy(input, SIGNAL(textEdited()));
+    QVERIFY(textEditedSpy.isValid());
+
+    input->forceActiveFocus();
+    QTRY_VERIFY(input->hasActiveFocus());
+
+    int textChanges = 0;
+    int textEdits = 0;
+
+    QTest::keyClick(&window, Qt::Key_A);
+    QCOMPARE(textChangedSpy.count(), ++textChanges);
+    QCOMPARE(textEditedSpy.count(), ++textEdits);
+
+    QTest::keyClick(&window, Qt::Key_B);
+    QCOMPARE(textChangedSpy.count(), ++textChanges);
+    QCOMPARE(textEditedSpy.count(), ++textEdits);
+
+    QTest::keyClick(&window, Qt::Key_C);
+    QCOMPARE(textChangedSpy.count(), ++textChanges);
+    QCOMPARE(textEditedSpy.count(), ++textEdits);
+
+    QTest::keyClick(&window, Qt::Key_Space);
+    QCOMPARE(textChangedSpy.count(), ++textChanges);
+    QCOMPARE(textEditedSpy.count(), ++textEdits);
+
+    QTest::keyClick(&window, Qt::Key_Backspace);
+    QCOMPARE(textChangedSpy.count(), ++textChanges);
+    QCOMPARE(textEditedSpy.count(), ++textEdits);
+
+    input->clear();
+    QCOMPARE(textChangedSpy.count(), ++textChanges);
+    QCOMPARE(textEditedSpy.count(), textEdits);
+
+    input->setText("TextInput");
+    QCOMPARE(textChangedSpy.count(), ++textChanges);
+    QCOMPARE(textEditedSpy.count(), textEdits);
+}
+
 /*
 TextInput element should only handle left/right keys until the cursor reaches
 the extent of the text, then they should ignore the keys.