IBus: Support a property ClientCommitPreedit

IBus added the ClientCommitPreedit property to handle
preedit in case.
If this writable property is set,
ibus_engine tells the client whether current preeditText
should be committed or not in the client side when
focusOutEvent.
(Qt's old behavior is always committing in the client side.)

Fixes: QTBUG-109576
Fixes: QTBUG-58005
Pick-to: 6.7 6.6 6.5
Change-Id: I6bb78921ce04cdd3197cba9e2fb00376d5e0ac8b
Reviewed-by: Liang Qi <liang.qi@qt.io>

1 files changed, 31 insertions, 4 deletions

diff --git a/src/plugins/platforminputcontexts/ibus/qibusplatforminputcontext.cpp b/src/plugins/platforminputcontexts/ibus/qibusplatforminputcontext.cpp
index b14772e1c7..4a1e9db75e 100644
--- a/src/plugins/platforminputcontexts/ibus/qibusplatforminputcontext.cpp
+++ b/src/plugins/platforminputcontexts/ibus/qibusplatforminputcontext.cpp
@@ -51,6 +51,13 @@ class QIBusPlatformInputContextPrivate
 {
     Q_DISABLE_COPY_MOVE(QIBusPlatformInputContextPrivate)
 public:
+    // This enum might be synced with IBusPreeditFocusMode
+    // in ibustypes.h of IBUS project
+    enum PreeditFocusMode {
+        PREEDIT_CLEAR   = 0,
+        PREEDIT_COMMIT  = 1,
+    };
+
     QIBusPlatformInputContextPrivate();
     ~QIBusPlatformInputContextPrivate()
     {
@@ -80,6 +87,7 @@ public:
     QList<QInputMethodEvent::Attribute> attributes;
     bool needsSurroundingText;
     QLocale locale;
+    PreeditFocusMode preeditFocusMode = PREEDIT_COMMIT; // for backward compatibility
 };
 
 
@@ -117,6 +125,7 @@ QIBusPlatformInputContext::QIBusPlatformInputContext ()
         if (ok && enableSync == 1)
             m_eventFilterUseSynchronousMode = true;
     }
+    d->context->setClientCommitPreedit(QIBusPropTypeClientCommitPreedit(true));
 }
 
 QIBusPlatformInputContext::~QIBusPlatformInputContext (void)
@@ -171,10 +180,18 @@ void QIBusPlatformInputContext::commit()
         return;
     }
 
-    if (!d->predit.isEmpty()) {
-        QInputMethodEvent event;
-        event.setCommitString(d->predit);
-        QCoreApplication::sendEvent(input, &event);
+    if (d->preeditFocusMode == QIBusPlatformInputContextPrivate::PREEDIT_COMMIT) {
+        if (!d->predit.isEmpty()) {
+            QInputMethodEvent event;
+            event.setCommitString(d->predit);
+            QCoreApplication::sendEvent(input, &event);
+        }
+    } else {
+        if (!d->predit.isEmpty()) {
+            // Clear the existing preedit
+            QInputMethodEvent event;
+            QCoreApplication::sendEvent(input, &event);
+        }
     }
 
     d->context->Reset();
@@ -318,6 +335,15 @@ void QIBusPlatformInputContext::updatePreeditText(const QDBusVariant &text, uint
     d->predit = t.text;
 }
 
+void QIBusPlatformInputContext::updatePreeditTextWithMode(const QDBusVariant &text, uint cursorPos, bool visible, uint mode)
+{
+    updatePreeditText(text, cursorPos, visible);
+    if (mode > 0)
+        d->preeditFocusMode = QIBusPlatformInputContextPrivate::PreeditFocusMode::PREEDIT_COMMIT;
+    else
+        d->preeditFocusMode = QIBusPlatformInputContextPrivate::PreeditFocusMode::PREEDIT_CLEAR;
+}
+
 void QIBusPlatformInputContext::forwardKeyEvent(uint keyval, uint keycode, uint state)
 {
     if (!qApp)
@@ -587,6 +613,7 @@ void QIBusPlatformInputContext::connectToContextSignals()
     if (d->context) {
         connect(d->context.get(), SIGNAL(CommitText(QDBusVariant)), SLOT(commitText(QDBusVariant)));
         connect(d->context.get(), SIGNAL(UpdatePreeditText(QDBusVariant,uint,bool)), this, SLOT(updatePreeditText(QDBusVariant,uint,bool)));
+        connect(d->context.get(), SIGNAL(UpdatePreeditTextWithMode(QDBusVariant,uint,bool,uint)), this, SLOT(updatePreeditTextWithMode(QDBusVariant,uint,bool,uint)));
         connect(d->context.get(), SIGNAL(ForwardKeyEvent(uint,uint,uint)), this, SLOT(forwardKeyEvent(uint,uint,uint)));
         connect(d->context.get(), SIGNAL(DeleteSurroundingText(int,uint)), this, SLOT(deleteSurroundingText(int,uint)));
         connect(d->context.get(), SIGNAL(RequireSurroundingText()), this, SLOT(surroundingTextRequired()));