Merge pull request slgobinath#745 from deltragon/ui-split-classes

refactor: ui: split items with templates into separate classes

Author: deltragon

safeeyes/ui/break_screen.py

@@ -39,16 +39,14 @@
 
 
 class BreakScreen:
-    """The fullscreen window which prevents users from using the computer.
+    """The fullscreen windows which prevent users from using the computer.
 
-    This class reads the break_screen.glade and build the user
-    interface.
+    This class creates and manages the fullscreen windows for every monitor.
     """
 
     def __init__(self, application, context, on_skipped, on_postponed):
         self.application = application
         self.context = context
-        self.count_labels = []
         self.x11_display = None
         self.enable_postpone = False
         self.enable_shortcut = False
@@ -100,11 +98,6 @@ def postpone_break(self):
         self.on_postponed()
         self.close()
 
-    def on_window_delete(self, *args):
-        """Window close event handler."""
-        logging.info("Closing the break screen")
-        self.close()
-
     def on_skip_clicked(self, button):
         """Skip button press event handler."""
         self.skip_break()
@@ -140,16 +133,6 @@ def close(self):
         # Destroy other windows if exists
         GLib.idle_add(lambda: self.__destroy_all_screens())
 
-    def __tray_action(self, button, tray_action: TrayAction):
-        """Tray action handler.
-
-        Hides all toolbar buttons for this action, if it is single use,
-        and call the action provided by the plugin.
-        """
-        if tray_action.single_use:
-            tray_action.reset()
-        tray_action.action()
-
     def __show_break_screen(self, message, image_path, widget, tray_actions):
         """Show an empty break screen on all screens."""
         # Lock the keyboard
@@ -171,12 +154,20 @@ def __show_break_screen(self, message, image_path, widget, tray_actions):
         i = 0
 
         for monitor in monitors:
-            builder = Gtk.Builder()
-            builder.add_from_file(BREAK_SCREEN_GLADE)
+            w = BreakScreenWindow(
+                self.application,
+                message,
+                image_path,
+                widget,
+                tray_actions,
+                lambda: self.close(),
+                self.show_postpone_button,
+                self.on_postpone_clicked,
+                self.show_skip_button,
+                self.on_skip_clicked,
+            )
 
-            window = builder.get_object("window_main")
-            window.set_application(self.application)
-            window.connect("close-request", self.on_window_delete)
+            window = w.window
 
             if self.context["is_wayland"]:
                 # Note: in theory, this could also be used on X11
@@ -187,54 +178,8 @@ def __show_break_screen(self, message, image_path, widget, tray_actions):
                 window.add_controller(controller)
 
             window.set_title("SafeEyes-" + str(i))
-            lbl_message = builder.get_object("lbl_message")
-            lbl_count = builder.get_object("lbl_count")
-            lbl_widget = builder.get_object("lbl_widget")
-            img_break = builder.get_object("img_break")
-            box_buttons = builder.get_object("box_buttons")
-            toolbar = builder.get_object("toolbar")
-
-            for tray_action in tray_actions:
-                # TODO: apparently, this would be better served with an icon theme
-                # + Gtk.button.new_from_icon_name
-                icon = tray_action.get_icon()
-                toolbar_button = Gtk.Button()
-                toolbar_button.set_child(icon)
-                tray_action.add_toolbar_button(toolbar_button)
-                toolbar_button.connect(
-                    "clicked",
-                    lambda button, action: self.__tray_action(button, action),
-                    tray_action,
-                )
-                toolbar_button.set_tooltip_text(_(tray_action.name))
-                toolbar.append(toolbar_button)
-                toolbar_button.show()
-
-            # Add the buttons
-            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 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")
-                btn_skip.connect("clicked", self.on_skip_clicked)
-                btn_skip.set_visible(True)
-                box_buttons.append(btn_skip)
-
-            # Set values
-            if image_path:
-                img_break.set_from_file(image_path)
-            lbl_message.set_label(message)
-            lbl_widget.set_markup(widget)
-
-            self.windows.append(window)
-            self.count_labels.append(lbl_count)
+
+            self.windows.append(w)
 
             if self.context["desktop"] == "kde":
                 # Fix flickering screen in KDE by setting opacity to 1
@@ -259,8 +204,8 @@ def __show_break_screen(self, message, image_path, widget, tray_actions):
 
     def __update_count_down(self, count):
         """Update the countdown on all break screens."""
-        for label in self.count_labels:
-            label.set_text(count)
+        for window in self.windows:
+            window.set_count_down(count)
 
     def __window_set_keep_above_x11(self, window):
         """Use EWMH hints to keep window above and on all desktops."""
@@ -353,6 +298,98 @@ def __release_keyboard_x11(self):
     def __destroy_all_screens(self):
         """Close all the break screens."""
         for win in self.windows:
-            win.destroy()
+            win.window.destroy()
         del self.windows[:]
-        del self.count_labels[:]
+
+
+class BreakScreenWindow:
+    """This class manages the UI for the break screen window.
+
+    Each instance is a single window, covering a single monitor.
+    """
+
+    def __init__(
+        self,
+        application,
+        message,
+        image_path,
+        widget,
+        tray_actions,
+        on_close,
+        show_postpone,
+        on_postpone,
+        show_skip,
+        on_skip,
+    ):
+        self.on_close = on_close
+
+        builder = Gtk.Builder()
+        builder.add_from_file(BREAK_SCREEN_GLADE)
+
+        self.window = builder.get_object("window_main")
+        self.window.set_application(application)
+        self.window.connect("close-request", self.on_window_delete)
+
+        lbl_message = builder.get_object("lbl_message")
+        self.lbl_count = builder.get_object("lbl_count")
+        lbl_widget = builder.get_object("lbl_widget")
+        img_break = builder.get_object("img_break")
+        box_buttons = builder.get_object("box_buttons")
+        toolbar = builder.get_object("toolbar")
+
+        for tray_action in tray_actions:
+            # TODO: apparently, this would be better served with an icon theme
+            # + Gtk.button.new_from_icon_name
+            icon = tray_action.get_icon()
+            toolbar_button = Gtk.Button()
+            toolbar_button.set_child(icon)
+            tray_action.add_toolbar_button(toolbar_button)
+            toolbar_button.connect(
+                "clicked",
+                lambda button, action: self.__tray_action(button, action),
+                tray_action,
+            )
+            toolbar_button.set_tooltip_text(_(tray_action.name))
+            toolbar.append(toolbar_button)
+            toolbar_button.show()
+
+        # Add the buttons
+        if show_postpone:
+            # Add postpone button
+            btn_postpone = Gtk.Button.new_with_label(_("Postpone"))
+            btn_postpone.get_style_context().add_class("btn_postpone")
+            btn_postpone.connect("clicked", on_postpone)
+            btn_postpone.set_visible(True)
+            box_buttons.append(btn_postpone)
+
+        if show_skip:
+            # Add the skip button
+            btn_skip = Gtk.Button.new_with_label(_("Skip"))
+            btn_skip.get_style_context().add_class("btn_skip")
+            btn_skip.connect("clicked", on_skip)
+            btn_skip.set_visible(True)
+            box_buttons.append(btn_skip)
+
+        # Set values
+        if image_path:
+            img_break.set_from_file(image_path)
+        lbl_message.set_label(message)
+        lbl_widget.set_markup(widget)
+
+    def set_count_down(self, count):
+        self.lbl_count.set_text(count)
+
+    def __tray_action(self, button, tray_action: TrayAction):
+        """Tray action handler.
+
+        Hides all toolbar buttons for this action and call the action
+        provided by the plugin.
+        """
+        if tray_action.single_use:
+            tray_action.reset()
+        tray_action.action()
+
+    def on_window_delete(self, *args):
+        """Window close event handler."""
+        logging.info("Closing the break screen")
+        self.on_close()