Renamed from Libremsonic to Sublime Music

sublime/ui/common/edit_form_dialog.py

@@ -0,0 +1,116 @@
+from typing import List, Tuple
+
+import gi
+gi.require_version('Gtk', '3.0')
+from gi.repository import Gtk
+
+
+class EditFormDialog(Gtk.Dialog):
+    entity_name: str
+    title: str
+    initial_size: Tuple[int, int]
+    text_fields: List[Tuple[str, str, bool]] = []
+    boolean_fields: List[Tuple[str, str]] = []
+    numeric_fields: List[Tuple[str, str]] = []
+    extra_buttons: List[Gtk.Button] = []
+
+    def get_object_name(self, obj):
+        """
+        Gets the friendly object name. Can be overridden.
+        """
+        return obj.name if obj else ''
+
+    def get_default_object(self):
+        return None
+
+    def __init__(self, parent, existing_object=None):
+        editing = existing_object is not None
+        title = getattr(self, 'title', lambda: None)
+        if not title:
+            if editing:
+                title = f'Edit {self.get_object_name(existing_object)}'
+            else:
+                title = f'Create New {self.entity_name}'
+
+        Gtk.Dialog.__init__(
+            self,
+            title=title,
+            transient_for=parent,
+            flags=0,
+        )
+        if not existing_object:
+            existing_object = self.get_default_object()
+
+        self.set_default_size(*self.initial_size)
+
+        # Store a map of field label to GTK component.
+        self.data = {}
+
+        content_area = self.get_content_area()
+        content_grid = Gtk.Grid(
+            column_spacing=10,
+            row_spacing=5,
+            margin_left=10,
+            margin_right=10,
+        )
+
+        # Add the text entries to the content area.
+        i = 0
+        for label, value_field_name, is_password in self.text_fields:
+            entry_label = Gtk.Label(label=label + ':')
+            entry_label.set_halign(Gtk.Align.START)
+            content_grid.attach(entry_label, 0, i, 1, 1)
+
+            entry = Gtk.Entry(
+                text=getattr(existing_object, value_field_name, ''),
+                hexpand=True,
+            )
+            if is_password:
+                entry.set_visibility(False)
+            content_grid.attach(entry, 1, i, 1, 1)
+            self.data[value_field_name] = entry
+
+            i += 1
+
+        # Add the boolean entries to the content area.
+        for label, value_field_name in self.boolean_fields:
+            entry_label = Gtk.Label(label=label + ':')
+            entry_label.set_halign(Gtk.Align.START)
+            content_grid.attach(entry_label, 0, i, 1, 1)
+
+            # Put the checkbox in the right box. Note we have to pad here
+            # since the checkboxes are smaller than the text fields.
+            checkbox = Gtk.CheckButton(
+                active=getattr(existing_object, value_field_name, False))
+            self.data[value_field_name] = checkbox
+            content_grid.attach(checkbox, 1, i, 1, 1)
+            i += 1
+
+        # Add the spin button entries to the content area.
+        for label, value_field_name, range_config, default_value in self.numeric_fields:
+            entry_label = Gtk.Label(label=label + ':')
+            entry_label.set_halign(Gtk.Align.START)
+            content_grid.attach(entry_label, 0, i, 1, 1)
+
+            # Put the checkbox in the right box. Note we have to pad here
+            # since the checkboxes are smaller than the text fields.
+            spin_button = Gtk.SpinButton.new_with_range(*range_config)
+            spin_button.set_value(
+                getattr(existing_object, value_field_name, default_value))
+            self.data[value_field_name] = spin_button
+            content_grid.attach(spin_button, 1, i, 1, 1)
+            i += 1
+
+        content_area.pack_start(content_grid, True, True, 10)
+
+        for button, response_id in self.extra_buttons:
+            self.add_action_widget(button, response_id)
+
+        self.add_buttons(
+            Gtk.STOCK_CANCEL,
+            Gtk.ResponseType.CANCEL,
+            Gtk.STOCK_EDIT if editing else Gtk.STOCK_ADD,
+            Gtk.ResponseType.OK,
+        )
+
+        self.show_all()