Add a way to control when software input panels are shown in TextInput and TextEdit elements

Task-number: QTBUG-10841
Reviewed-by: Warwick Allison

6 files changed, 273 insertions, 21 deletions

diff --git a/src/declarative/graphicsitems/qdeclarativetextedit.cpp b/src/declarative/graphicsitems/qdeclarativetextedit.cpp
index a154d53..d4fbb8b 100644
--- a/src/declarative/graphicsitems/qdeclarativetextedit.cpp
+++ b/src/declarative/graphicsitems/qdeclarativetextedit.cpp
@@ -940,7 +940,6 @@ Handles the given mouse \a event.
 void QDeclarativeTextEdit::mousePressEvent(QGraphicsSceneMouseEvent *event)
 {
     Q_D(QDeclarativeTextEdit);
-    bool hadFocus = hasFocus();
     if (d->focusOnPress){
         QGraphicsItem *p = parentItem();//###Is there a better way to find my focus scope?
         while(p) {
@@ -950,8 +949,6 @@ void QDeclarativeTextEdit::mousePressEvent(QGraphicsSceneMouseEvent *event)
         }
         setFocus(true);
     }
-    if (!hadFocus && hasFocus())
-        d->clickCausedFocus = true;
     if (event->type() != QEvent::GraphicsSceneMouseDoubleClick || d->selectByMouse)
         d->control->processEvent(event, QPointF(0, -d->yoff));
     if (!event->isAccepted())
@@ -965,11 +962,6 @@ Handles the given mouse \a event.
 void QDeclarativeTextEdit::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
 {
     Q_D(QDeclarativeTextEdit);
-    QWidget *widget = event->widget();
-    if (widget && (d->control->textInteractionFlags() & Qt::TextEditable) && boundingRect().contains(event->pos()))
-        qt_widget_private(widget)->handleSoftwareInputPanel(event->button(), d->clickCausedFocus);
-    d->clickCausedFocus = false;
-
     d->control->processEvent(event, QPointF(0, -d->yoff));
     if (!event->isAccepted())
         QDeclarativePaintedItem::mouseReleaseEvent(event);
@@ -1205,4 +1197,127 @@ void QDeclarativeTextEditPrivate::updateDefaultTextOption()
     document->setDefaultTextOption(opt);
 }
 
+
+/*!
+    \qmlmethod void TextEdit::openSoftwareInputPanel()
+
+    Opens software input panels like virtual keyboards for typing, useful for
+    customizing when you want the input keyboard to be shown and hidden in
+    your application.
+
+    By default input panels are shown when TextEdit element gains focus and hidden
+    when the focus is lost. You can disable the automatic behavior by setting the
+    property showInputPanelOnFocus to false and use functions openSoftwareInputPanel()
+    and closeSoftwareInputPanel() to implement the behavior you want.
+
+    Only relevant on platforms, which provide virtual keyboards.
+
+    \code
+        import Qt 4.7
+        TextEdit {
+            id: textEdit
+            text: "Hello world!"
+            showInputPanelOnFocus: false
+            MouseArea {
+                anchors.fill: parent
+                onClicked: textEdit.openSoftwareInputPanel()
+            }
+            onFocusChanged: if (!focus) closeSoftwareInputpanel()
+        }
+    \endcode
+*/
+void QDeclarativeTextEdit::openSoftwareInputPanel()
+{
+    QEvent event(QEvent::RequestSoftwareInputPanel);
+    if (qApp) {
+        if (QGraphicsView * view = qobject_cast<QGraphicsView*>(qApp->focusWidget())) {
+            if (view->scene() && view->scene() == scene()) {
+                QApplication::sendEvent(view, &event);
+            }
+        }
+    }
+}
+
+/*!
+    \qmlmethod void TextEdit::closeSoftwareInputPanel()
+
+    Closes a software input panel like a virtual keyboard shown on the screen, useful
+    for customizing when you want the input keyboard to be shown and hidden in
+    your application.
+
+    By default input panels are shown when TextEdit element gains focus and hidden
+    when the focus is lost. You can disable the automatic behavior by setting the
+    property showInputPanelOnFocus to false and use functions openSoftwareInputPanel()
+    and closeSoftwareInputPanel() to implement the behavior you want.
+
+    Only relevant on platforms, which provide virtual keyboards.
+
+    \code
+        import Qt 4.7
+        TextEdit {
+            id: textEdit
+            text: "Hello world!"
+            showInputPanelOnFocus: false
+            MouseArea {
+                anchors.fill: parent
+                onClicked: textEdit.openSoftwareInputPanel()
+            }
+            onFocusChanged: if (!focus) closeSoftwareInputpanel()
+        }
+    \endcode
+*/
+void QDeclarativeTextEdit::closeSoftwareInputPanel()
+{
+    QEvent event(QEvent::CloseSoftwareInputPanel);
+    if (qApp) {
+        if (QGraphicsView * view = qobject_cast<QGraphicsView*>(qApp->focusWidget())) {
+            if (view->scene() && view->scene() == scene()) {
+                QApplication::sendEvent(view, &event);
+            }
+        }
+    }
+}
+
+/*!
+    \qmlproperty bool TextEdit::showInputPanelOnFocus
+    Whether input panels are automatically shown when TextEdit element gains
+    focus and hidden when focus is lost. By default this is set to true.
+
+    Only relevant on platforms, which provide virtual keyboards.
+*/
+bool QDeclarativeTextEdit::showInputPanelOnFocus() const
+{
+    Q_D(const QDeclarativeTextEdit);
+    return d->showInputPanelOnFocus;
+}
+
+void QDeclarativeTextEdit::setShowInputPanelOnFocus(bool showOnFocus)
+{
+    Q_D(QDeclarativeTextEdit);
+    if (d->showInputPanelOnFocus == showOnFocus)
+        return;
+
+    d->showInputPanelOnFocus = showOnFocus;
+
+    emit showInputPanelOnFocusChanged(d->showInputPanelOnFocus);
+}
+
+void QDeclarativeTextEdit::focusInEvent(QFocusEvent *event)
+{
+    Q_D(const QDeclarativeTextEdit);
+    if (d->showInputPanelOnFocus && !isReadOnly()) {
+        openSoftwareInputPanel();
+    }
+    QDeclarativePaintedItem::focusInEvent(event);
+}
+
+void QDeclarativeTextEdit::focusOutEvent(QFocusEvent *event)
+{
+    Q_D(const QDeclarativeTextEdit);
+    if (d->showInputPanelOnFocus && !isReadOnly()) {
+        closeSoftwareInputPanel();
+    }
+    QDeclarativePaintedItem::focusOutEvent(event);
+}
+
 QT_END_NAMESPACE
diff --git a/src/declarative/graphicsitems/qdeclarativetextedit_p.h b/src/declarative/graphicsitems/qdeclarativetextedit_p.h
index 891b868..fdac5cf 100644
--- a/src/declarative/graphicsitems/qdeclarativetextedit_p.h
+++ b/src/declarative/graphicsitems/qdeclarativetextedit_p.h
@@ -84,6 +84,7 @@ class Q_DECLARATIVE_EXPORT QDeclarativeTextEdit : public QDeclarativePaintedItem
     Q_PROPERTY(int selectionEnd READ selectionEnd WRITE setSelectionEnd NOTIFY selectionEndChanged)
     Q_PROPERTY(QString selectedText READ selectedText NOTIFY selectionChanged)
     Q_PROPERTY(bool focusOnPress READ focusOnPress WRITE setFocusOnPress NOTIFY focusOnPressChanged)
+    Q_PROPERTY(bool showInputPanelOnFocus READ showInputPanelOnFocus WRITE setShowInputPanelOnFocus NOTIFY showInputPanelOnFocusChanged)
     Q_PROPERTY(bool persistentSelection READ persistentSelection WRITE setPersistentSelection NOTIFY persistentSelectionChanged)
     Q_PROPERTY(qreal textMargin READ textMargin WRITE setTextMargin NOTIFY textMarginChanged)
     Q_PROPERTY(Qt::InputMethodHints inputMethodHints READ inputMethodHints WRITE setInputMethodHints)
@@ -116,6 +117,9 @@ public:
                     WrapAtWordBoundaryOrAnywhere = QTextOption::WrapAtWordBoundaryOrAnywhere
                   };
 
+    Q_INVOKABLE void openSoftwareInputPanel();
+    Q_INVOKABLE void closeSoftwareInputPanel();
+
     QString text() const;
     void setText(const QString &);
 
@@ -163,6 +167,9 @@ public:
     bool focusOnPress() const;
     void setFocusOnPress(bool on);
 
+    bool showInputPanelOnFocus() const;
+    void setShowInputPanelOnFocus(bool showOnFocus);
+
     bool persistentSelection() const;
     void setPersistentSelection(bool on);
 
@@ -207,6 +214,7 @@ Q_SIGNALS:
     void persistentSelectionChanged(bool isPersistentSelection);
     void textMarginChanged(qreal textMargin);
     void selectByMouseChanged(bool selectByMouse);
+    void showInputPanelOnFocusChanged(bool showOnFocus);
 
 public Q_SLOTS:
     void selectAll();
@@ -228,6 +236,8 @@ protected:
     bool event(QEvent *);
     void keyPressEvent(QKeyEvent *);
     void keyReleaseEvent(QKeyEvent *);
+    void focusInEvent(QFocusEvent *event);
+    void focusOutEvent(QFocusEvent *event);
 
     // mouse filter?
     void mousePressEvent(QGraphicsSceneMouseEvent *event);
diff --git a/src/declarative/graphicsitems/qdeclarativetextedit_p_p.h b/src/declarative/graphicsitems/qdeclarativetextedit_p_p.h
index d96796c..8e1d630 100644
--- a/src/declarative/graphicsitems/qdeclarativetextedit_p_p.h
+++ b/src/declarative/graphicsitems/qdeclarativetextedit_p_p.h
@@ -70,9 +70,9 @@ public:
     QDeclarativeTextEditPrivate()
       : color("black"), hAlign(QDeclarativeTextEdit::AlignLeft), vAlign(QDeclarativeTextEdit::AlignTop),
       imgDirty(true), dirty(false), richText(false), cursorVisible(false), focusOnPress(true),
-      persistentSelection(true), clickCausedFocus(false), textMargin(0.0), lastSelectionStart(0), lastSelectionEnd(0),
-      cursorComponent(0), cursor(0), format(QDeclarativeTextEdit::AutoText), document(0),
-      wrapMode(QDeclarativeTextEdit::NoWrap),
+      showInputPanelOnFocus(true), persistentSelection(true), textMargin(0.0), lastSelectionStart(0),
+      lastSelectionEnd(0), cursorComponent(0), cursor(0), format(QDeclarativeTextEdit::AutoText),
+      document(0), wrapMode(QDeclarativeTextEdit::NoWrap),
       selectByMouse(false),
       yoff(0)
     {
@@ -101,8 +101,8 @@ public:
     bool richText : 1;
     bool cursorVisible : 1;
     bool focusOnPress : 1;
+    bool showInputPanelOnFocus : 1;
     bool persistentSelection : 1;
-    bool clickCausedFocus : 1;
     qreal textMargin;
     int lastSelectionStart;
     int lastSelectionEnd;
diff --git a/src/declarative/graphicsitems/qdeclarativetextinput.cpp b/src/declarative/graphicsitems/qdeclarativetextinput.cpp
index 1ac1b4e..47cd110 100644
--- a/src/declarative/graphicsitems/qdeclarativetextinput.cpp
+++ b/src/declarative/graphicsitems/qdeclarativetextinput.cpp
@@ -886,7 +886,6 @@ void QDeclarativeTextInput::keyPressEvent(QKeyEvent* ev)
 void QDeclarativeTextInput::mousePressEvent(QGraphicsSceneMouseEvent *event)
 {
     Q_D(QDeclarativeTextInput);
-    bool hadFocus = hasFocus();
     if(d->focusOnPress){
         QGraphicsItem *p = parentItem();//###Is there a better way to find my focus scope?
         while(p) {
@@ -896,8 +895,6 @@ void QDeclarativeTextInput::mousePressEvent(QGraphicsSceneMouseEvent *event)
         }
         setFocus(true);
     }
-    if (!hadFocus && hasFocus())
-        d->clickCausedFocus = true;
 
     bool mark = event->modifiers() & Qt::ShiftModifier;
     int cursor = d->xToPos(event->pos().x());
@@ -923,10 +920,7 @@ Handles the given mouse \a event.
 void QDeclarativeTextInput::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
 {
     Q_D(QDeclarativeTextInput);
-    QWidget *widget = event->widget();
-    if (widget && !d->control->isReadOnly() && boundingRect().contains(event->pos()))
-        qt_widget_private(widget)->handleSoftwareInputPanel(event->button(), d->clickCausedFocus);
-    d->clickCausedFocus = false;
+    d->control->processEvent(event);
     if (!event->isAccepted())
         QDeclarativePaintedItem::mouseReleaseEvent(event);
 }
@@ -1175,6 +1169,129 @@ void QDeclarativeTextInput::moveCursorSelection(int position)
     d->control->moveCursor(position, true);
 }
 
+/*!
+    \qmlmethod void TextInput::openSoftwareInputPanel()
+
+    Opens software input panels like virtual keyboards for typing, useful for
+    customizing when you want the input keyboard to be shown and hidden in
+    your application.
+
+    By default input panels are shown when TextInput element gains focus and hidden
+    when the focus is lost. You can disable the automatic behavior by setting the
+    property showInputPanelOnFocus to false and use functions openSoftwareInputPanel()
+    and closeSoftwareInputPanel() to implement the behavior you want.
+
+    Only relevant on platforms, which provide virtual keyboards.
+
+    \code
+        import Qt 4.7
+        TextInput {
+            id: textInput
+            text: "Hello world!"
+            showInputPanelOnFocus: false
+            MouseArea {
+                anchors.fill: parent
+                onClicked: textInput.openSoftwareInputPanel()
+            }
+            onFocusChanged: if (!focus) closeSoftwareInputPanel()
+        }
+    \endcode
+*/
+void QDeclarativeTextInput::openSoftwareInputPanel()
+{
+    QEvent event(QEvent::RequestSoftwareInputPanel);
+    if (qApp) {
+        if (QGraphicsView * view = qobject_cast<QGraphicsView*>(qApp->focusWidget())) {
+            if (view->scene() && view->scene() == scene()) {
+                QApplication::sendEvent(view, &event);
+            }
+        }
+    }
+}
+
+/*!
+    \qmlmethod void TextInput::closeSoftwareInputPanel()
+
+    Closes a software input panel like a virtual keyboard shown on the screen, useful
+    for customizing when you want the input keyboard to be shown and hidden in
+    your application.
+
+    By default input panels are shown when TextInput element gains focus and hidden
+    when the focus is lost. You can disable the automatic behavior by setting the
+    property showInputPanelOnFocus to false and use functions openSoftwareInputPanel()
+    and closeSoftwareInputPanel() to implement the behavior you want.
+
+    Only relevant on platforms, which provide virtual keyboards.
+
+    \code
+        import Qt 4.7
+        TextInput {
+            id: textInput
+            text: "Hello world!"
+            showInputPanelOnFocus: false
+            MouseArea {
+                anchors.fill: parent
+                onClicked: textInput.openSoftwareInputPanel()
+            }
+            onFocusChanged: if (!focus) closeSoftwareInputPanel()
+        }
+    \endcode
+*/
+void QDeclarativeTextInput::closeSoftwareInputPanel()
+{
+    QEvent event(QEvent::CloseSoftwareInputPanel);
+    if (qApp) {
+        QEvent event(QEvent::CloseSoftwareInputPanel);
+        if (QGraphicsView * view = qobject_cast<QGraphicsView*>(qApp->focusWidget())) {
+            if (view->scene() && view->scene() == scene()) {
+                QApplication::sendEvent(view, &event);
+            }
+        }
+    }
+}
+
+/*!
+    \qmlproperty bool TextInput::showInputPanelOnFocus
+    Whether input panels are automatically shown when TextInput element gains
+    focus and hidden when focus is lost. By default this is set to true.
+
+    Only relevant on platforms, which provide virtual keyboards.
+*/
+bool QDeclarativeTextInput::showInputPanelOnFocus() const
+{
+    Q_D(const QDeclarativeTextInput);
+    return d->showInputPanelOnFocus;
+}
+
+void QDeclarativeTextInput::setShowInputPanelOnFocus(bool showOnFocus)
+{
+    Q_D(QDeclarativeTextInput);
+    if (d->showInputPanelOnFocus == showOnFocus)
+        return;
+
+    d->showInputPanelOnFocus = showOnFocus;
+
+    emit showInputPanelOnFocusChanged(d->showInputPanelOnFocus);
+}
+
+void QDeclarativeTextInput::focusInEvent(QFocusEvent *event)
+{
+    Q_D(const QDeclarativeTextInput);
+    if (d->showInputPanelOnFocus && !isReadOnly()) {
+        openSoftwareInputPanel();
+    }
+    QDeclarativePaintedItem::focusInEvent(event);
+}
+
+void QDeclarativeTextInput::focusOutEvent(QFocusEvent *event)
+{
+    Q_D(const QDeclarativeTextInput);
+    if (d->showInputPanelOnFocus && !isReadOnly()) {
+        closeSoftwareInputPanel();
+    }
+    QDeclarativePaintedItem::focusOutEvent(event);
+}
+
 void QDeclarativeTextInputPrivate::init()
 {
     Q_Q(QDeclarativeTextInput);
diff --git a/src/declarative/graphicsitems/qdeclarativetextinput_p.h b/src/declarative/graphicsitems/qdeclarativetextinput_p.h
index b2fd057..438293a 100644
--- a/src/declarative/graphicsitems/qdeclarativetextinput_p.h
+++ b/src/declarative/graphicsitems/qdeclarativetextinput_p.h
@@ -86,6 +86,7 @@ class Q_DECLARATIVE_EXPORT QDeclarativeTextInput : public QDeclarativePaintedIte
     Q_PROPERTY(bool acceptableInput READ hasAcceptableInput NOTIFY acceptableInputChanged)
     Q_PROPERTY(EchoMode echoMode READ echoMode WRITE setEchoMode NOTIFY echoModeChanged)
     Q_PROPERTY(bool focusOnPress READ focusOnPress WRITE setFocusOnPress NOTIFY focusOnPressChanged)
+    Q_PROPERTY(bool showInputPanelOnFocus READ showInputPanelOnFocus WRITE setShowInputPanelOnFocus NOTIFY showInputPanelOnFocusChanged)
     Q_PROPERTY(QString passwordCharacter READ passwordCharacter WRITE setPasswordCharacter NOTIFY passwordCharacterChanged)
     Q_PROPERTY(QString displayText READ displayText NOTIFY displayTextChanged)
     Q_PROPERTY(bool autoScroll READ autoScroll WRITE setAutoScroll NOTIFY autoScrollChanged)
@@ -112,6 +113,9 @@ public:
     Q_INVOKABLE int xToPosition(int x);
     Q_INVOKABLE void moveCursorSelection(int pos);
 
+    Q_INVOKABLE void openSoftwareInputPanel();
+    Q_INVOKABLE void closeSoftwareInputPanel();
+
     QString text() const;
     void setText(const QString &);
 
@@ -172,6 +176,9 @@ public:
     bool focusOnPress() const;
     void setFocusOnPress(bool);
 
+    bool showInputPanelOnFocus() const;
+    void setShowInputPanelOnFocus(bool showOnFocus);
+
     bool autoScroll() const;
     void setAutoScroll(bool);
 
@@ -208,6 +215,7 @@ Q_SIGNALS:
     void focusOnPressChanged(bool focusOnPress);
     void autoScrollChanged(bool autoScroll);
     void selectByMouseChanged(bool selectByMouse);
+    void showInputPanelOnFocusChanged(bool showOnFocus);
 
 protected:
     virtual void geometryChanged(const QRectF &newGeometry,
@@ -218,6 +226,8 @@ protected:
     void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
     void keyPressEvent(QKeyEvent* ev);
     bool event(QEvent *e);
+    void focusInEvent(QFocusEvent *event);
+    void focusOutEvent(QFocusEvent *event);
 
 public Q_SLOTS:
     void selectAll();
diff --git a/src/declarative/graphicsitems/qdeclarativetextinput_p_p.h b/src/declarative/graphicsitems/qdeclarativetextinput_p_p.h
index 1d8e0f7..f44d014 100644
--- a/src/declarative/graphicsitems/qdeclarativetextinput_p_p.h
+++ b/src/declarative/graphicsitems/qdeclarativetextinput_p_p.h
@@ -72,7 +72,7 @@ public:
                  color((QRgb)0), style(QDeclarativeText::Normal),
                  styleColor((QRgb)0), hAlign(QDeclarativeTextInput::AlignLeft),
                  hscroll(0), oldScroll(0), focused(false), focusOnPress(true),
-                 cursorVisible(false), autoScroll(true), clickCausedFocus(false),
+                 showInputPanelOnFocus(true), cursorVisible(false), autoScroll(true),
                  selectByMouse(false)
     {
     }
@@ -115,9 +115,9 @@ public:
     int oldScroll;
     bool focused;
     bool focusOnPress;
+    bool showInputPanelOnFocus;
     bool cursorVisible;
     bool autoScroll;
-    bool clickCausedFocus;
     bool selectByMouse;
 };