TextInput: add editingFinished signal

Autotest is included.

Task-number: QTBUG-34780

[ChangeLog][QtDeclarative][TextInput] add editingFinished signal

Change-Id: Ib633daee67cd4e5f15739a6004adbe882ab3d3fc
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: J-P Nurmi <jpnurmi@digia.com>
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
Reviewed-by: Alan Alpert (Personal) <416365416c@gmail.com>

5 files changed, 75 insertions, 0 deletions

diff --git a/src/quick/items/qquickitemsmodule.cpp b/src/quick/items/qquickitemsmodule.cpp
index ebc32c89eb..a5b78b28e1 100644
--- a/src/quick/items/qquickitemsmodule.cpp
+++ b/src/quick/items/qquickitemsmodule.cpp
@@ -188,6 +188,7 @@ static void qt_quickitems_defineModule(const char *uri, int major, int minor)
     qmlRegisterType<QQuickTextEdit>(uri,major,minor,"TextEdit");
     qmlRegisterType<QQuickTextEdit,1>(uri,2,1,"TextEdit");
     qmlRegisterType<QQuickTextInput>(uri,major,minor,"TextInput");
+    qmlRegisterType<QQuickTextInput,2>(uri,2,2,"TextInput");
     qmlRegisterType<QQuickViewSection>(uri,major,minor,"ViewSection");
 
     qmlRegisterType<QQuickItemLayer>();
diff --git a/src/quick/items/qquicktextinput.cpp b/src/quick/items/qquicktextinput.cpp
index 93ea677d2c..b46387ba47 100644
--- a/src/quick/items/qquicktextinput.cpp
+++ b/src/quick/items/qquicktextinput.cpp
@@ -1212,6 +1212,17 @@ bool QQuickTextInput::hasAcceptableInput() const
     state.
 */
 
+/*!
+    \qmlsignal QtQuick::TextInput::onEditingFinished()
+    \since 5.2
+
+    This handler is called when the Return or Enter key is pressed or
+    the text input loses focus. Note that if there is a validator or
+    inputMask set on the text input and enter/return is pressed, this
+    handler will only be called if the input follows
+    the inputMask and the validator returns an acceptable state.
+*/
+
 #ifndef QT_NO_IM
 Qt::InputMethodHints QQuickTextInputPrivate::effectiveInputMethodHints() const
 {
@@ -2522,6 +2533,9 @@ void QQuickTextInputPrivate::handleFocusEvent(QFocusEvent *event)
                 && !persistentSelection)
             deselect();
 
+        if (hasAcceptableInput(m_text) || fixup())
+            emit q->editingFinished();
+
 #ifndef QT_NO_IM
         q->disconnect(qApp->inputMethod(), SIGNAL(inputDirectionChanged(Qt::LayoutDirection)),
                       q, SLOT(q_updateAlignment()));
@@ -4105,6 +4119,7 @@ void QQuickTextInputPrivate::processKeyEvent(QKeyEvent* event)
     if (event->key() == Qt::Key_Enter || event->key() == Qt::Key_Return) {
         if (hasAcceptableInput(m_text) || fixup()) {
             emit q->accepted();
+            emit q->editingFinished();
         }
         event->ignore();
         return;
diff --git a/src/quick/items/qquicktextinput_p.h b/src/quick/items/qquicktextinput_p.h
index 2b72afb9dc..5f0250aaf1 100644
--- a/src/quick/items/qquicktextinput_p.h
+++ b/src/quick/items/qquicktextinput_p.h
@@ -284,6 +284,7 @@ Q_SIGNALS:
     void selectedTextChanged();
     void accepted();
     void acceptableInputChanged();
+    Q_REVISION(2) void editingFinished();
     void colorChanged();
     void selectionColorChanged();
     void selectedTextColorChanged();
diff --git a/tests/auto/quick/qquicktextinput/data/signal_editingfinished.qml b/tests/auto/quick/qquicktextinput/data/signal_editingfinished.qml
new file mode 100644
index 0000000000..2ec5ce6676
--- /dev/null
+++ b/tests/auto/quick/qquicktextinput/data/signal_editingfinished.qml
@@ -0,0 +1,13 @@
+import QtQuick 2.2
+
+Item {
+    property variant input1: input1
+    property variant input2: input2
+
+    width: 800; height: 600;
+
+    Column{
+        TextInput { id: input1; }
+        TextInput { id: input2; }
+    }
+}
diff --git a/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp b/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp
index 1c2ab4d948..80726720e4 100644
--- a/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp
+++ b/tests/auto/quick/qquicktextinput/tst_qquicktextinput.cpp
@@ -146,6 +146,8 @@ private slots:
     void validators();
     void inputMethods();
 
+    void signal_editingfinished();
+
     void passwordCharacter();
     void cursorDelegate_data();
     void cursorDelegate();
@@ -2303,6 +2305,49 @@ void tst_qquicktextinput::inputMethods()
     QCOMPARE(enabledQueryEvent.value(Qt::ImEnabled).toBool(), false);
 }
 
+void tst_qquicktextinput::signal_editingfinished()
+{
+    QQuickView window(testFileUrl("signal_editingfinished.qml"));
+    window.show();
+    window.requestActivate();
+    QTest::qWaitForWindowActive(&window);
+
+    QVERIFY(window.rootObject() != 0);
+
+    QQuickTextInput *input1 = qobject_cast<QQuickTextInput *>(qvariant_cast<QObject *>(window.rootObject()->property("input1")));
+    QVERIFY(input1);
+    QQuickTextInput *input2 = qobject_cast<QQuickTextInput *>(qvariant_cast<QObject *>(window.rootObject()->property("input2")));
+    QVERIFY(input2);
+    QSignalSpy input1Spy(input1, SIGNAL(editingFinished()));
+
+    input1->setFocus(true);
+    QTRY_VERIFY(input1->hasActiveFocus());
+    QTRY_VERIFY(!input2->hasActiveFocus());
+
+    QTest::keyPress(&window, Qt::Key_A);
+    QTest::keyRelease(&window, Qt::Key_A, Qt::NoModifier);
+    QTRY_COMPARE(input1->text(), QLatin1String("a"));
+
+    QTest::keyPress(&window, Qt::Key_Enter);
+    QTest::keyRelease(&window, Qt::Key_Enter, Qt::NoModifier);
+    QTRY_COMPARE(input1Spy.count(), 1);
+
+    QSignalSpy input2Spy(input2, SIGNAL(editingFinished()));
+
+    input2->setFocus(true);
+    QTRY_VERIFY(!input1->hasActiveFocus());
+    QTRY_VERIFY(input2->hasActiveFocus());
+
+    QTest::keyPress(&window, Qt::Key_A);
+    QTest::keyRelease(&window, Qt::Key_A, Qt::NoModifier);
+    QTRY_COMPARE(input2->text(), QLatin1String("a"));
+
+    input1->setFocus(true);
+    QTRY_VERIFY(input1->hasActiveFocus());
+    QTRY_VERIFY(!input2->hasActiveFocus());
+    QTRY_COMPARE(input2Spy.count(), 1);
+}
+
 /*
 TextInput element should only handle left/right keys until the cursor reaches
 the extent of the text, then they should ignore the keys.