Add EnterKey attached property

This adds an attached property EnterKey allowing to manipulate the
Enter key appearance.

[ChangeLog][QtQuick][Item] Added EnterKey attached property that allows
to change the appearance of the Enter key on an on-screen keyboard

Change-Id: Ic9a01b0217c317e4ed3a9eef1fa01f2f113f0294
Reviewed-by: Alan Alpert <aalpert@blackberry.com>

3 files changed, 101 insertions, 0 deletions

diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp
index 94b89d0fc4..f6bae315ec 100644
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -1608,6 +1608,74 @@ void QQuickItemPrivate::setLayoutMirror(bool mirror)
     }
 }
 
+/*!
+    \qmltype EnterKey
+    \instantiates QQuickEnterKeyAttached
+    \inqmlmodule QtQuick
+    \ingroup qtquick-input
+    \since 5.6
+    \brief Property used to manipulate Enter key appearance
+
+    The EnterKey attached property is used to manipulate the appearance and behavior of the Enter key
+    on an on-screen keyboard.
+*/
+
+/*!
+    \qmlproperty bool QtQuick::EnterKey::type
+
+    This property holds the type of the Enter key.
+
+    \note Not all of these values are supported on all platforms.
+    For unsupported values the default key will be used instead.
+
+    \li Qt.EnterKeyDefault      The default Enter key.
+                                This can either be a button closing the keyboard, or a Return button
+                                causing a new line in case of a multi-line input field.
+    \li Qt.EnterKeyReturn       Show a Return button that inserts a new line.
+    \li Qt.EnterKeyDone         Show a "Done" button.
+                                Typically the keyboard is expected to close when the button is pressed.
+    \li Qt.EnterKeyGo           Show a "Go" button.
+                                Typically used in an address bar when entering a URL.
+    \li Qt.EnterKeySend         Show a "Send" button.
+    \li Qt.EnterKeySearch       Show a "Search" button.
+    \li Qt.EnterKeyNext         Show a "Next" button.
+                                Typically used in a form to allow navigating to the next input field
+                                without the keyboard closing.
+    \li Qt.EnterKeyPrevious     Show a "Previous" button.
+*/
+
+QQuickEnterKeyAttached::QQuickEnterKeyAttached(QObject *parent)
+    : QObject(parent), itemPrivate(0), keyType(Qt::EnterKeyDefault)
+{
+    if (QQuickItem *item = qobject_cast<QQuickItem*>(parent)) {
+        itemPrivate = QQuickItemPrivate::get(item);
+        itemPrivate->extra.value().enterKeyAttached = this;
+    } else
+        qmlInfo(parent) << tr("EnterKey attached property only works with Items");
+}
+
+QQuickEnterKeyAttached *QQuickEnterKeyAttached::qmlAttachedProperties(QObject *object)
+{
+    return new QQuickEnterKeyAttached(object);
+}
+
+Qt::EnterKeyType QQuickEnterKeyAttached::type() const
+{
+    return keyType;
+}
+
+void QQuickEnterKeyAttached::setType(Qt::EnterKeyType type)
+{
+    if (keyType != type) {
+        keyType = type;
+#ifndef QT_NO_IM
+        if (itemPrivate && itemPrivate->activeFocus)
+            QGuiApplication::inputMethod()->update(Qt::ImEnterKeyType);
+#endif
+        typeChanged();
+    }
+}
+
 void QQuickItemPrivate::setAccessible()
 {
     isAccessible = true;
@@ -3960,6 +4028,11 @@ QVariant QQuickItem::inputMethodQuery(Qt::InputMethodQuery query) const
     case Qt::ImPreferredLanguage:
         if (d->extra.isAllocated() && d->extra->keyHandler)
             v = d->extra->keyHandler->inputMethodQuery(query);
+        break;
+    case Qt::ImEnterKeyType:
+        if (d->extra.isAllocated() && d->extra->enterKeyAttached)
+            v = d->extra->enterKeyAttached->type();
+        break;
     default:
         break;
     }
@@ -7816,6 +7889,7 @@ void QQuickItemLayer::updateMatrix()
 QQuickItemPrivate::ExtraData::ExtraData()
 : z(0), scale(1), rotation(0), opacity(1),
   contents(0), screenAttached(0), layoutDirectionAttached(0),
+  enterKeyAttached(0),
   keyHandler(0), layer(0),
   effectRefCount(0), hideRefCount(0),
   opacityNode(0), clipNode(0), rootNode(0),
diff --git a/src/quick/items/qquickitem_p.h b/src/quick/items/qquickitem_p.h
index c0d06da829..5e0246c32e 100644
--- a/src/quick/items/qquickitem_p.h
+++ b/src/quick/items/qquickitem_p.h
@@ -78,6 +78,7 @@ QT_BEGIN_NAMESPACE
 class QNetworkReply;
 class QQuickItemKeyFilter;
 class QQuickLayoutMirroringAttached;
+class QQuickEnterKeyAttached;
 class QQuickScreenAttached;
 
 class QQuickContents : public QQuickItemChangeListener
@@ -338,6 +339,7 @@ public:
         QQuickContents *contents;
         QQuickScreenAttached *screenAttached;
         QQuickLayoutMirroringAttached* layoutDirectionAttached;
+        QQuickEnterKeyAttached *enterKeyAttached;
         QQuickItemKeyFilter *keyHandler;
         mutable QQuickItemLayer *layer;
 #ifndef QT_NO_CURSOR
@@ -709,6 +711,27 @@ private:
     QQuickItemPrivate *itemPrivate;
 };
 
+class QQuickEnterKeyAttached : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY(Qt::EnterKeyType type READ type WRITE setType NOTIFY typeChanged)
+
+public:
+    explicit QQuickEnterKeyAttached(QObject *parent = Q_NULLPTR);
+
+    Qt::EnterKeyType type() const;
+    void setType(Qt::EnterKeyType type);
+
+    static QQuickEnterKeyAttached *qmlAttachedProperties(QObject *);
+Q_SIGNALS:
+    void typeChanged();
+private:
+    friend class QQuickItemPrivate;
+    QQuickItemPrivate *itemPrivate;
+
+    Qt::EnterKeyType keyType;
+};
+
 class QQuickKeysAttachedPrivate : public QObjectPrivate
 {
 public:
@@ -893,5 +916,7 @@ QML_DECLARE_TYPE(QQuickKeyNavigationAttached)
 QML_DECLARE_TYPEINFO(QQuickKeyNavigationAttached, QML_HAS_ATTACHED_PROPERTIES)
 QML_DECLARE_TYPE(QQuickLayoutMirroringAttached)
 QML_DECLARE_TYPEINFO(QQuickLayoutMirroringAttached, QML_HAS_ATTACHED_PROPERTIES)
+QML_DECLARE_TYPE(QQuickEnterKeyAttached)
+QML_DECLARE_TYPEINFO(QQuickEnterKeyAttached, QML_HAS_ATTACHED_PROPERTIES)
 
 #endif // QQUICKITEM_P_H
diff --git a/src/quick/items/qquickitemsmodule.cpp b/src/quick/items/qquickitemsmodule.cpp
index 8a6766770e..4df1ef038c 100644
--- a/src/quick/items/qquickitemsmodule.cpp
+++ b/src/quick/items/qquickitemsmodule.cpp
@@ -271,6 +271,8 @@ static void qt_quickitems_defineModule(const char *uri, int major, int minor)
     qmlRegisterType<QQuickRow, 6>(uri, 2, 6, "Row");
     qmlRegisterType<QQuickGrid, 6>(uri, 2, 6, "Grid");
     qmlRegisterType<QQuickFlow, 6>(uri, 2, 6, "Flow");
+    qmlRegisterUncreatableType<QQuickEnterKeyAttached, 6>(uri, 2, 6, "EnterKey",
+                                                           QQuickEnterKeyAttached::tr("EnterKey is only available via attached properties"));
 }
 
 static void initResources()