[gnome-shell/wip/carlosg/osk-candidates-visibility] ibusCandidatePopup: Set OSK candidates list visibility correctly

[Carlos Garnacho <carlosg src gnome org>]

commit 81c5bf389f411ac1e480f2d80b049f68ae7e338c
Author: Carlos Garnacho <carlosg gnome org>
Date:   Wed Jun 29 13:06:07 2022 +0200

    ibusCandidatePopup: Set OSK candidates list visibility correctly
    
    Right now, we don't pay much attention to visibility hints from IBus
    about the candidates list for the OSK suggestions bar. Since some
    IMs rely on this visibility being honored, do that.
    
    To fix this, the visibility hints for the lookup table are now
    propagated to the keyboard, so the Suggestions actor hides its
    internal candidate buttons. Since the Suggestions actor gets its
    minimum height from CSS, this does not result in OSK size jumps.
    
    Closes: https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/5601

 js/ui/ibusCandidatePopup.js |  3 +++
 js/ui/keyboard.js           | 11 +++++++++++
 2 files changed, 14 insertions(+)
---
diff --git a/js/ui/ibusCandidatePopup.js b/js/ui/ibusCandidatePopup.js
index c57e289cbb..340f9a8e1a 100644
--- a/js/ui/ibusCandidatePopup.js
+++ b/js/ui/ibusCandidatePopup.js
@@ -270,6 +270,7 @@ class IbusCandidatePopup extends BoxPointer.BoxPointer {
                 indexes.push(indexLabel.get_text());
 
             Main.keyboard.resetSuggestions();
+            Main.keyboard.setSuggestionsVisible(visible);
 
             let candidates = [];
             for (let i = startIndex; i < endIndex; ++i) {
@@ -289,10 +290,12 @@ class IbusCandidatePopup extends BoxPointer.BoxPointer {
             this._candidateArea.updateButtons(lookupTable.is_round(), page, nPages);
         });
         panelService.connect('show-lookup-table', () => {
+            Main.keyboard.setSuggestionsVisible(true);
             this._candidateArea.show();
             this._updateVisibility();
         });
         panelService.connect('hide-lookup-table', () => {
+            Main.keyboard.setSuggestionsVisible(false);
             this._candidateArea.hide();
             this._updateVisibility();
         });
diff --git a/js/ui/keyboard.js b/js/ui/keyboard.js
index 499bc28a90..7dd5df9581 100644
--- a/js/ui/keyboard.js
+++ b/js/ui/keyboard.js
@@ -227,6 +227,13 @@ class Suggestions extends St.BoxLayout {
     clear() {
         this.remove_all_children();
     }
+
+    setVisible(visible) {
+        let actor;
+        for (actor = this.get_first_child();
+            actor !== null; actor = actor.get_next_sibling())
+            actor.visible = visible;
+    }
 });
 
 var LanguageSelectionPopup = class extends PopupMenu.PopupMenu {
@@ -1937,6 +1944,10 @@ var Keyboard = GObject.registerClass({
             this._suggestions.clear();
     }
 
+    setSuggestionsVisible(visible) {
+        this._suggestions?.setVisible(visible);
+    }
+
     addSuggestion(text, callback) {
         if (!this._suggestions)
             return;