settings: refactor plugin settings items into classes

Author: deltragon

safeeyes/ui/settings_dialog.py

@@ -445,6 +445,49 @@ def on_properties_clicked(self, button):
             self.on_properties()
 
 
+class IntItem:
+    def __init__(self, name, value, min_value, max_value):
+        super().__init__()
+
+        builder = utility.create_gtk_builder(SETTINGS_ITEM_INT_GLADE)
+        builder.get_object("lbl_name").set_label(_(name))
+        self.spin_value = builder.get_object("spin_value")
+        self.spin_value.set_range(min_value, max_value)
+        self.spin_value.set_value(value)
+        self.box = builder.get_object("box")
+
+    def get_value(self):
+        return self.spin_value.get_value()
+
+
+class TextItem:
+    def __init__(self, name, value):
+        super().__init__()
+
+        builder = utility.create_gtk_builder(SETTINGS_ITEM_TEXT_GLADE)
+        builder.get_object("lbl_name").set_label(_(name))
+        self.txt_value = builder.get_object("txt_value")
+        self.txt_value.set_text(value)
+        self.box = builder.get_object("box")
+
+    def get_value(self):
+        return self.txt_value.get_text()
+
+
+class BoolItem:
+    def __init__(self, name, value):
+        super().__init__()
+
+        builder = utility.create_gtk_builder(SETTINGS_ITEM_BOOL_GLADE)
+        builder.get_object("lbl_name").set_label(_(name))
+        self.switch_value = builder.get_object("switch_value")
+        self.switch_value.set_active(value)
+        self.box = builder.get_object("box")
+
+    def get_value(self):
+        return self.switch_value.get_active()
+
+
 class PluginSettingsDialog:
     """Builds a settings dialog based on the configuration of a plugin."""
 
@@ -459,67 +502,33 @@ def __init__(self, parent, config):
         self.window.set_title(_("Plugin Settings"))
         for setting in config.get("settings"):
             if setting["type"].upper() == "INT":
-                box = self.__load_int_item(
+                box = IntItem(
                     setting["label"],
-                    setting["id"],
-                    config["active_plugin_config"],
+                    config["active_plugin_config"][setting["id"]],
                     setting.get("min", 0),
                     setting.get("max", 120),
                 )
             elif setting["type"].upper() == "TEXT":
-                box = self.__load_text_item(
-                    setting["label"], setting["id"], config["active_plugin_config"]
+                box = TextItem(
+                    setting["label"], config["active_plugin_config"][setting["id"]]
                 )
             elif setting["type"].upper() == "BOOL":
-                box = self.__load_bool_item(
-                    setting["label"], setting["id"], config["active_plugin_config"]
+                box = BoolItem(
+                    setting["label"], config["active_plugin_config"][setting["id"]]
                 )
             else:
                 continue
 
-            box_settings.append(box)
+            self.property_controls.append({"key": setting["id"], "box": box})
+            box_settings.append(box.box)
 
         self.window.connect("close-request", self.on_window_delete)
 
-    def __load_int_item(self, name, key, settings, min_value, max_value):
-        """Load the UI control for int property."""
-        builder = utility.create_gtk_builder(SETTINGS_ITEM_INT_GLADE)
-        builder.get_object("lbl_name").set_label(_(name))
-        spin_value = builder.get_object("spin_value")
-        spin_value.set_range(min_value, max_value)
-        spin_value.set_value(settings[key])
-        box = builder.get_object("box")
-        box.set_visible(True)
-        self.property_controls.append({"key": key, "value": spin_value.get_value})
-        return box
-
-    def __load_text_item(self, name, key, settings):
-        """Load the UI control for text property."""
-        builder = utility.create_gtk_builder(SETTINGS_ITEM_TEXT_GLADE)
-        builder.get_object("lbl_name").set_label(_(name))
-        txt_value = builder.get_object("txt_value")
-        txt_value.set_text(settings[key])
-        box = builder.get_object("box")
-        box.set_visible(True)
-        self.property_controls.append({"key": key, "value": txt_value.get_text})
-        return box
-
-    def __load_bool_item(self, name, key, settings):
-        """Load the UI control for boolean property."""
-        builder = utility.create_gtk_builder(SETTINGS_ITEM_BOOL_GLADE)
-        builder.get_object("lbl_name").set_label(_(name))
-        switch_value = builder.get_object("switch_value")
-        switch_value.set_active(settings[key])
-        box = builder.get_object("box")
-        box.set_visible(True)
-        self.property_controls.append({"key": key, "value": switch_value.get_active})
-        return box
-
     def on_window_delete(self, *args):
         """Event handler for Properties dialog close action."""
         for property_control in self.property_controls:
             self.config["active_plugin_config"][property_control["key"]] = (
-                property_control["value"]()
+                property_control["box"].get_value()
             )
         self.window.destroy()