Disable Cinnamon built-in shortcuts, keyboard applet when using

fcitx.

Add an infobar to InputSources.py with explanation and a button
to launch fcitx5-configtool.

Only pass the primary keyboard layout to the x11 server.

Author: mtwebster

files/usr/share/cinnamon/applets/keyboard@cinnamon.org/applet.js

@@ -8,6 +8,7 @@ const Signals = imports.signals;
 const KeyboardManager = imports.ui.keyboardManager;
 const IBus = imports.gi.IBus;
 const IBusManager = imports.misc.ibusManager;
+const IMFramework = imports.misc.imFramework;
 const SignalManager = imports.misc.signalManager;
 
 const PANEL_EDIT_MODE_KEY = "panel-edit-mode";
@@ -57,11 +58,16 @@ class CinnamonKeyboardApplet extends Applet.Applet {
         this._selectedLayout = null;
         this._layoutItems = new Map();
 
+        // Under fcitx, layout/IME state and indication belong to fcitx's own tray
+        // icon. Stay hidden and don't suppress the external IM's tray icon.
+        this._imIsFcitx = IMFramework.getFramework() === IMFramework.FRAMEWORK_FCITX;
 
         try {
             this.metadata = metadata;
-            Main.systrayManager.registerTrayIconReplacement("keyboard", metadata.uuid);
-            Main.systrayManager.registerTrayIconReplacement("input-method", metadata.uuid);
+            if (!this._imIsFcitx) {
+                Main.systrayManager.registerTrayIconReplacement("keyboard", metadata.uuid);
+                Main.systrayManager.registerTrayIconReplacement("input-method", metadata.uuid);
+            }
 
             this.menuManager = new PopupMenu.PopupMenuManager(this);
             this.menu = new Applet.AppletPopupMenu(this, orientation);
@@ -119,7 +125,8 @@ class CinnamonKeyboardApplet extends Applet.Applet {
     }
 
     _onPanelEditModeChanged() {
-        this.actor.visible = global.settings.get_boolean(PANEL_EDIT_MODE_KEY) || this._inputSourcesManager.multipleSources;
+        this.actor.visible = !this._imIsFcitx &&
+            (global.settings.get_boolean(PANEL_EDIT_MODE_KEY) || this._inputSourcesManager.multipleSources);
     }
 
     on_applet_added_to_panel() {
@@ -180,7 +187,7 @@ class CinnamonKeyboardApplet extends Applet.Applet {
             this._layoutSection.addMenuItem(menuItem);
         }
 
-        if (!this._inputSourcesManager.multipleSources) {
+        if (this._imIsFcitx || !this._inputSourcesManager.multipleSources) {
             this.menu.close();
             this.actor.hide();
         } else {
@@ -220,7 +227,7 @@ class CinnamonKeyboardApplet extends Applet.Applet {
 
         this._panel_icon_box.set_child(actor);
 
-        if (!this._inputSourcesManager.multipleSources) {
+        if (this._imIsFcitx || !this._inputSourcesManager.multipleSources) {
             this.actor.hide();
         }
 

files/usr/share/cinnamon/cinnamon-settings/bin/InputSources.py

@@ -15,6 +15,7 @@
 from xapp.GSettingsWidgets import PXGSettingsBackend, GSettingsSwitch
 
 from bin import AddKeyboardLayout
+from bin.util import using_fcitx
 
 MAX_LAYOUTS_PER_GROUP = 4
 
@@ -47,6 +48,10 @@ def __init__(self):
 
         self.engine_config_button = builder.get_object("engine_config_button")
         self.engine_config_button.connect("clicked", self.on_engine_config_clicked)
+        # Configure is ibus-engine-specific; fcitx engines are configured in fcitx.
+        if using_fcitx():
+            self.engine_config_button.set_no_show_all(True)
+            self.engine_config_button.set_visible(False)
         self.add_layout_button = builder.get_object("add_layout")
         self.add_layout_button.connect("clicked", self.on_add_layout_clicked)
         self.remove_layout_button = builder.get_object("remove_layout")
@@ -58,6 +63,31 @@ def __init__(self):
 
         self.update_widgets()
 
+        if using_fcitx():
+            # Under fcitx, layout switching, the applet and per-window memory are
+            # owned by fcitx, and input methods are configured in fcitx's own
+            # tools. Explain that, with handoffs to those tools, in place of our
+            # options/shortcuts.
+            infobar = Gtk.InfoBar()
+            infobar.set_message_type(Gtk.MessageType.INFO)
+            label = Gtk.Label(
+                _("In Fcitx mode, input methods, additional layouts and their "
+                  "switching shortcuts are managed by Fcitx. Only the first "
+                  "layout configured here is used.")
+            )
+            label.set_line_wrap(True)
+            label.set_xalign(0.0)
+            infobar.get_content_area().add(label)
+
+            manage_button = Gtk.Button(label=_("Manage Fcitx"))
+            manage_button.connect("clicked", lambda widget: subprocess.Popen(["fcitx5-configtool"]))
+            infobar.get_action_area().pack_start(manage_button, False, False, 0)
+
+            infobar.show_all()
+            self.pack_start(infobar, False, False, 0)
+            self.reorder_child(infobar, 0)
+            return
+
         section = self.add_section(_("Options"))
         widget = GSettingsSwitch(
             _("Remember the last layout used for each window"),

files/usr/share/cinnamon/cinnamon-settings/bin/KeybindingTable.py

@@ -12,6 +12,8 @@
 gi.require_version("Gtk", "3.0")
 from gi.repository import Gtk, Gdk, Gio, GObject, GLib
 
+from bin import util
+
 gettext.install("cinnamon", "/usr/share/locale")
 
 # Keybindings page - check if we need to store custom
@@ -591,6 +593,10 @@ def _load_category(cat):
                 category.add(kb)
 
         for category in STATIC_KEYBINDINGS:
+            # The "Keyboard" category is just the layout-switch shortcuts; under
+            # fcitx, switching is owned by fcitx, so hide the whole category.
+            if category[1] == "keyboard" and util.using_fcitx():
+                continue
             _load_category(category)
 
     def _on_enabled_spices_changed(self, settings, key, data=None):

files/usr/share/cinnamon/cinnamon-settings/bin/util.py

@@ -47,3 +47,9 @@ def get_session_type():
         pass
 
     return None
+
+def using_fcitx():
+    # Mirror js/misc/imFramework.js: only an explicit fcitx selection (exported by
+    # im-config at session start) changes our behaviour; everything else is ibus.
+    mod = (os.environ.get("GTK_IM_MODULE") or os.environ.get("XMODIFIERS") or "").lower()
+    return "fcitx" in mod

js/ui/keyboardManager.js

@@ -7,6 +7,7 @@ const Signals = imports.signals;
 const ByteArray = imports.byteArray;
 
 const IBusManager = imports.misc.ibusManager;
+const IMFramework = imports.misc.imFramework;
 const LoginManager = imports.misc.loginManager;
 const Main = imports.ui.main;
 const PopupMenu = imports.ui.popupMenu;
@@ -165,6 +166,13 @@ var KeyboardManager = class {
     }
 
     _buildGroupStrings(_group) {
+        if (IMFramework.getFramework() === IMFramework.FRAMEWORK_FCITX) {
+            // Under fcitx, Cinnamon owns only the base layout; fcitx manages any
+            // alternate layouts itself (in-process). Send a single-group keymap.
+            let base = _group[0] || this._localeLayoutInfo;
+            return [base.layout, base.variant];
+        }
+
         let alreadyIncluded = _group.some(g => g.layout === this._localeLayoutInfo.layout &&
                                                 g.variant === this._localeLayoutInfo.variant);
         let group = alreadyIncluded ? _group : _group.concat(this._localeLayoutInfo);
@@ -550,6 +558,10 @@ var InputSourceManager = class {
     }
 
     _setupKeybindings() {
+        // Under fcitx, layout/IME switching is owned by fcitx's own shortcuts.
+        if (IMFramework.getFramework() === IMFramework.FRAMEWORK_FCITX)
+            return;
+
         let kb = this._kb_settings.get_strv("switch-input-source");
         Main.keybindingManager.addHotKeyArray(
             "switch-input-source", kb,