mouse-click-effects@anaximeno: Add keybinding settings (#646)

anaximeno · web-flow · commit b29e51d9fb6e · 2024-05-30T17:31:35.000-04:00
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/5.4/constants.js b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/5.4/constants.js
@@ -0,0 +1,22 @@
+/* constants.js
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+'use strict';
+
+const UUID = "mouse-click-effects@anaximeno";
+
+const PAUSE_EFFECTS_KEY = `${UUID}-bind-pause-effects`;
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/5.4/extension.js b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/5.4/extension.js
@@ -17,25 +17,25 @@
  */
 'use strict';
 
+const Main = imports.ui.main;
 const Settings = imports.ui.settings;
 const Gettext = imports.gettext;
 const SignalManager = imports.misc.signalManager;
 const { Atspi, GLib, Gio } = imports.gi;
 const { ClickAnimationFactory } = require("./clickAnimations.js");
 const { Debouncer } = require("./helpers.js");
+const { UUID, PAUSE_EFFECTS_KEY } = require("./constants.js");
 
 
-const LOCALE_DIR = GLib.get_home_dir() + "/.local/share/locale";
-const UUID = "mouse-click-effects@anaximeno";
-
-Gettext.bindtextdomain(UUID, LOCALE_DIR);
+Gettext.bindtextdomain(UUID, `${GLib.get_home_dir()}/.local/share/locale`);
 
 
 function _(text) {
 	let localized = Gettext.dgettext(UUID, text);
 	return localized != text ? localized : window._(text);
 }
 
+
 const ClickType = {
     LEFT: "left_click",
     MIDDLE: "middle_click",
@@ -57,16 +57,22 @@ class MouseClickEffects {
 		this.signals.connect(global.screen, 'in-fullscreen-changed', this.on_fullscreen_changed, this);
 
 		this._click_animation = ClickAnimationFactory.createForMode(this.animation_mode);
+
 		this.display_click = (new Debouncer()).debounce(this._animate_click.bind(this), 2);
 		this.colored_icon_store = {};
+		this.enabled = false;
+
 		this.update_colored_icons();
+		this.set_keybindings();
 	}
 
     _init_data_dir(uuid) {
 		let data_dir = `${GLib.get_user_cache_dir()}/${uuid}`;
 
-		if (GLib.mkdir_with_parents(`${data_dir}/icons`, 0o777) < 0)
+		if (GLib.mkdir_with_parents(`${data_dir}/icons`, 0o777) < 0) {
+			global.logError(`Failed to create cache dir at ${data_dir}`);
 			throw new Error(`Failed to create cache dir at ${data_dir}`);
+		}
 
 		return data_dir;
 	}
@@ -129,6 +135,11 @@ class MouseClickEffects {
 				value: "animation_mode",
 				cb: this.update_animation_mode,
 			},
+			{
+				key: "pause-effects-binding",
+				value: "pause_effects_binding",
+				cb: this.set_keybindings,
+			},
 			{
 				key: "deactivate-in-fullscreen",
 				value: "deactivate_in_fullscreen",
@@ -150,9 +161,27 @@ class MouseClickEffects {
 	}
 
 	disable() {
+		this.set_active(false);
+		this.unset_keybindings();
 		this.destroy();
 	}
 
+	unset_keybindings() {
+		Main.keybindingManager.removeHotKey(PAUSE_EFFECTS_KEY);
+	}
+
+	set_keybindings() {
+		this.unset_keybindings();
+        Main.keybindingManager.addHotKey(
+			PAUSE_EFFECTS_KEY,
+			this.pause_effects_binding,
+            () => {
+				global.log(UUID, `Click effects ${this.enabled ? "paused" : "resumed"}!`);
+				this.set_active(!this.enabled);
+			},
+		);
+    }
+
 	on_effects_enabled_updated(event) {
 		thib.on_property_updated(event);
 	}
@@ -203,6 +232,7 @@ class MouseClickEffects {
 	}
 
 	set_active(enabled) {
+		this.enabled = enabled;
 		this.listener.deregister('mouse');
 
 		if (enabled) {
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/5.4/settings-schema.json b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/5.4/settings-schema.json
@@ -72,6 +72,12 @@
 		"default": false,
 		"description": "Deactivate In Fullscreen"
 	},
+	"pause-effects-binding": {
+		"type": "keybinding",
+		"description": "Pause Effects Keybinding",
+		"default": "",
+		"tooltip": "Set keybinding to pause or continue the effects"
+	},
 
 	"events-section": {
 		"type": "section",
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/metadata.json b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/metadata.json
@@ -1,7 +1,7 @@
 {
     "uuid": "mouse-click-effects@anaximeno",
     "name": "Mouse Click Effects",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "description": "Display mouse click effects on Cinnamon.",
     "url": "https://github.com/anaximeno/mouse-click-effects",
     "website": "https://github.com/anaximeno/mouse-click-effects",
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/es.po b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/es.po
@@ -7,7 +7,7 @@ msgstr ""
 "Project-Id-Version: mouse-click-effects@anaximeno 0.1.0\n"
 "Report-Msgid-Bugs-To: https://github.com/linuxmint/cinnamon-spices-"
 "extensions/issues\n"
-"POT-Creation-Date: 2024-05-30 05:46-0100\n"
+"POT-Creation-Date: 2024-05-30 19:05-0100\n"
 "PO-Revision-Date: 2024-05-30 11:01-0400\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -153,6 +153,14 @@ msgstr "Opacidad general"
 msgid "Deactivate In Fullscreen"
 msgstr "Desactivar en pantalla completa"
 
+#. 5.4->settings-schema.json->pause-effects-binding->description
+msgid "Pause Effects Keybinding"
+msgstr ""
+
+#. 5.4->settings-schema.json->pause-effects-binding->tooltip
+msgid "Set keybinding to pause or continue the effects"
+msgstr ""
+
 #. 5.4->settings-schema.json->events-section->description
 msgid "Events"
 msgstr "Eventos"
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/eu.po b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/eu.po
@@ -6,8 +6,9 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: mouse-click-effects@anaximeno 0.1.0\n"
-"Report-Msgid-Bugs-To: https://github.com/linuxmint/cinnamon-spices-extensions/issues\n"
-"POT-Creation-Date: 2024-05-26 10:55-0100\n"
+"Report-Msgid-Bugs-To: https://github.com/linuxmint/cinnamon-spices-"
+"extensions/issues\n"
+"POT-Creation-Date: 2024-05-30 19:05-0100\n"
 "PO-Revision-Date: 2024-05-30 9:50+1\n"
 "Last-Translator: Muxutruk <muxutruk2@users.noreply.github.com>\n"
 "Language-Team: Basque <muxutruk2@users.noreply.github.com>\n"
@@ -104,6 +105,10 @@ msgstr "Zirkulua"
 msgid "Gear"
 msgstr "Engranaje"
 
+#. 5.4->settings-schema.json->icon-mode->options
+msgid "H-Star"
+msgstr ""
+
 #. 5.4->settings-schema.json->size->units
 msgid "px"
 msgstr "pixel"
@@ -148,6 +153,14 @@ msgstr "Opakutasun orokorra"
 msgid "Deactivate In Fullscreen"
 msgstr "Desaktibatu pantaila osoan"
 
+#. 5.4->settings-schema.json->pause-effects-binding->description
+msgid "Pause Effects Keybinding"
+msgstr ""
+
+#. 5.4->settings-schema.json->pause-effects-binding->tooltip
+msgid "Set keybinding to pause or continue the effects"
+msgstr ""
+
 #. 5.4->settings-schema.json->events-section->description
 msgid "Events"
 msgstr "Gertaerak"
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/mouse-click-effects@anaximeno.pot b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/mouse-click-effects@anaximeno.pot
@@ -5,10 +5,10 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: mouse-click-effects@anaximeno 0.2.0\n"
+"Project-Id-Version: mouse-click-effects@anaximeno 0.3.0\n"
 "Report-Msgid-Bugs-To: https://github.com/linuxmint/cinnamon-spices-"
 "extensions/issues\n"
-"POT-Creation-Date: 2024-05-30 05:46-0100\n"
+"POT-Creation-Date: 2024-05-30 19:05-0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -153,6 +153,14 @@ msgstr ""
 msgid "Deactivate In Fullscreen"
 msgstr ""
 
+#. 5.4->settings-schema.json->pause-effects-binding->description
+msgid "Pause Effects Keybinding"
+msgstr ""
+
+#. 5.4->settings-schema.json->pause-effects-binding->tooltip
+msgid "Set keybinding to pause or continue the effects"
+msgstr ""
+
 #. 5.4->settings-schema.json->events-section->description
 msgid "Events"
 msgstr ""
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/pt.po b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/pt.po
@@ -8,7 +8,7 @@ msgstr ""
 "Project-Id-Version: mouse-click-effects@anaximeno 0.1.0\n"
 "Report-Msgid-Bugs-To: https://github.com/linuxmint/cinnamon-spices-"
 "extensions/issues\n"
-"POT-Creation-Date: 2024-05-30 05:46-0100\n"
+"POT-Creation-Date: 2024-05-30 19:05-0100\n"
 "PO-Revision-Date: 2024-05-28 03:36-0100\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -154,6 +154,14 @@ msgstr "Opacidade Geral"
 msgid "Deactivate In Fullscreen"
 msgstr "Desativar em Tela Cheia"
 
+#. 5.4->settings-schema.json->pause-effects-binding->description
+msgid "Pause Effects Keybinding"
+msgstr ""
+
+#. 5.4->settings-schema.json->pause-effects-binding->tooltip
+msgid "Set keybinding to pause or continue the effects"
+msgstr ""
+
 #. 5.4->settings-schema.json->events-section->description
 msgid "Events"
 msgstr "Eventos"
diff --git a/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/zh.po b/mouse-click-effects@anaximeno/files/mouse-click-effects@anaximeno/po/zh.po
@@ -8,7 +8,7 @@ msgstr ""
 "Project-Id-Version: mouse-click-effects@anaximeno 0.1.0\n"
 "Report-Msgid-Bugs-To: https://github.com/linuxmint/cinnamon-spices-"
 "extensions/issues\n"
-"POT-Creation-Date: 2024-05-30 05:46-0100\n"
+"POT-Creation-Date: 2024-05-30 19:05-0100\n"
 "PO-Revision-Date: 2024-05-28 11:48+0800\n"
 "Last-Translator: 张鹏 <scbeta@qq.com>\n"
 "Language-Team: \n"
@@ -154,6 +154,14 @@ msgstr "常规透明度"
 msgid "Deactivate In Fullscreen"
 msgstr "全屏时不激活"
 
+#. 5.4->settings-schema.json->pause-effects-binding->description
+msgid "Pause Effects Keybinding"
+msgstr ""
+
+#. 5.4->settings-schema.json->pause-effects-binding->tooltip
+msgid "Set keybinding to pause or continue the effects"
+msgstr ""
+
 #. 5.4->settings-schema.json->events-section->description
 msgid "Events"
 msgstr "事件"

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"uuid": "mouse-click-effects@anaximeno",`
`3`	`3`	`"name": "Mouse Click Effects",`
`4`		`- "version": "0.2.0",`
	`4`	`+ "version": "0.3.0",`
`5`	`5`	`"description": "Display mouse click effects on Cinnamon.",`
`6`	`6`	`"url": "https://github.com/anaximeno/mouse-click-effects",`
`7`	`7`	`"website": "https://github.com/anaximeno/mouse-click-effects",`