Merge pull request slgobinath#716 from deltragon/gtk4-shortcuts

break screen shortcuts: implement on wayland

Author: deltragon

safeeyes/config/locale/safeeyes.pot

@@ -561,3 +561,6 @@ msgstr ""
 #, python-format
 msgid "Old stylesheet found at '%(old)s', ignoring. For custom styles, create a new stylesheet in '%(new)s' instead."
 msgstr ""
+
+msgid "Customizing the postpone and skip shortcuts does not work on Wayland."
+msgstr ""

safeeyes/ui/break_screen.py

@@ -52,13 +52,15 @@ def __init__(self, application, context, on_skipped, on_postponed):
         self.enable_postpone = False
         self.enable_shortcut = False
         self.is_pretified = False
-        self.keycode_shortcut_postpone = 65
-        self.keycode_shortcut_skip = 9
+        self.keycode_shortcut_postpone = 65  # Space
+        self.keycode_shortcut_skip = 9  # Escape
         self.on_postponed = on_postponed
         self.on_skipped = on_skipped
         self.shortcut_disable_time = 2
         self.strict_break = False
         self.windows = []
+        self.show_skip_button = False
+        self.show_postpone_button = False
 
         if not self.context["is_wayland"]:
             self.x11_display = Display()
@@ -69,6 +71,17 @@ def initialize(self, config):
         self.enable_postpone = config.get("allow_postpone", False)
         self.keycode_shortcut_postpone = config.get("shortcut_postpone", 65)
         self.keycode_shortcut_skip = config.get("shortcut_skip", 9)
+
+        if self.context["is_wayland"] and (
+            self.keycode_shortcut_postpone != 65 or self.keycode_shortcut_skip != 9
+        ):
+            logging.warning(
+                _(
+                    "Customizing the postpone and skip shortcuts does not work on "
+                    "Wayland."
+                )
+            )
+
         self.shortcut_disable_time = config.get("shortcut_disable_time", 2)
         self.strict_break = config.get("strict_break", False)
 
@@ -146,7 +159,12 @@ def __show_break_screen(self, message, image_path, widget, tray_actions):
         logging.info("Show break screens in %d display(s)", len(monitors))
 
         skip_button_disabled = self.context.get("skip_button_disabled", False)
+        self.show_skip_button = not self.strict_break and not skip_button_disabled
+
         postpone_button_disabled = self.context.get("postpone_button_disabled", False)
+        self.show_postpone_button = (
+            self.enable_postpone and not postpone_button_disabled
+        )
 
         i = 0
 
@@ -157,6 +175,15 @@ def __show_break_screen(self, message, image_path, widget, tray_actions):
             window = builder.get_object("window_main")
             window.set_application(self.application)
             window.connect("close-request", self.on_window_delete)
+
+            if self.context["is_wayland"]:
+                # Note: in theory, this could also be used on X11
+                # however, that already has its own implementation below
+                controller = Gtk.EventControllerKey()
+                controller.connect("key_pressed", self.on_key_pressed_wayland)
+                controller.set_propagation_phase(Gtk.PropagationPhase.CAPTURE)
+                window.add_controller(controller)
+
             window.set_title("SafeEyes-" + str(i))
             lbl_message = builder.get_object("lbl_message")
             lbl_count = builder.get_object("lbl_count")
@@ -182,15 +209,15 @@ def __show_break_screen(self, message, image_path, widget, tray_actions):
                 toolbar_button.show()
 
             # Add the buttons
-            if self.enable_postpone and not postpone_button_disabled:
+            if self.show_postpone_button:
                 # Add postpone button
                 btn_postpone = Gtk.Button.new_with_label(_("Postpone"))
                 btn_postpone.get_style_context().add_class("btn_postpone")
                 btn_postpone.connect("clicked", self.on_postpone_clicked)
                 btn_postpone.set_visible(True)
                 box_buttons.append(btn_postpone)
 
-            if not self.strict_break and not skip_button_disabled:
+            if self.show_skip_button:
                 # Add the skip button
                 btn_skip = Gtk.Button.new_with_label(_("Skip"))
                 btn_skip.get_style_context().add_class("btn_skip")
@@ -214,6 +241,11 @@ def __show_break_screen(self, message, image_path, widget, tray_actions):
             window.fullscreen_on_monitor(monitor)
             window.present()
 
+            # this ensures that none of the buttons is in focus immediately
+            # otherwise, pressing space presses that button instead of triggering the
+            # shortcut
+            window.set_focus(None)
+
             if not self.context["is_wayland"]:
                 self.__window_set_keep_above_x11(window)
 
@@ -284,20 +316,31 @@ def __lock_keyboard_x11(self):
                 if self.enable_shortcut and event.type == X.KeyPress:
                     if (
                         event.detail == self.keycode_shortcut_skip
-                        and not self.strict_break
+                        and self.show_skip_button
                     ):
                         self.skip_break()
                         break
                     elif (
-                        self.enable_postpone
-                        and event.detail == self.keycode_shortcut_postpone
+                        event.detail == self.keycode_shortcut_postpone
+                        and self.show_postpone_button
                     ):
                         self.postpone_break()
                         break
             else:
                 # Reduce the CPU usage by sleeping for a second
                 time.sleep(1)
 
+    def on_key_pressed_wayland(self, event_controller_key, keyval, keycode, state):
+        if self.enable_shortcut:
+            if keyval == Gdk.KEY_space and self.show_postpone_button:
+                self.postpone_break()
+                return True
+            elif keyval == Gdk.KEY_Escape and self.show_skip_button:
+                self.skip_break()
+                return True
+
+        return False
+
     def __release_keyboard_x11(self):
         """Release the locked keyboard."""
         logging.info("Unlock the keyboard")