feat(editor): add RadioTabWidget

Author: beatreichenbach

qt_parameters/editor.py

@@ -7,6 +7,7 @@
 
 from . import utils
 from .box import CollapsibleBox
+from .rediotab import RadioTabWidget
 from .scrollarea import VerticalScrollArea
 from .widgets import ParameterWidget, BoolParameter
 
@@ -206,6 +207,9 @@ def values(self) -> dict[str, Any]:
                 values[name] = widget.values()
             elif isinstance(widget, CollapsibleBox):
                 values[name] = widget.checked()
+            elif isinstance(widget, RadioTabWidget):
+                if form := self.form(name.replace('_enabled', '')):
+                    values[name] = widget.currentWidget() == form
         return values
 
     def set_values(self, values: dict) -> None:
@@ -220,6 +224,10 @@ def set_values(self, values: dict) -> None:
                 widget.set_values(value)
             elif isinstance(widget, CollapsibleBox):
                 widget.set_checked(value)
+            elif isinstance(widget, RadioTabWidget):
+                if value:
+                    if form := self.form(name.replace('_enabled', '')):
+                        widget.setCurrentWidget(form)
 
     def set_defaults(self, values: dict) -> None:
         """Set the default values of ParameterWidgets in the form."""
@@ -318,14 +326,23 @@ def add_form(self, form: ParameterForm, checkable: bool = False) -> CollapsibleB
 
         return box
 
-    def add_forms(self, forms: Sequence[ParameterForm]) -> QtWidgets.QTabWidget:
-        """Add multiple forms and return the TabWidget."""
+    def add_forms(
+        self, forms: Sequence[ParameterForm], radio: bool = False
+    ) -> QtWidgets.QTabWidget:
+        """
+        Add multiple forms and return the TabWidget. If radio is True, use a
+        RadioTabWidget which only allows one form to be active.
+        """
 
         # Validate the names before creating any widgets.
         for form in forms:
             self._validate_name(form.name())
 
-        tab_widget = QtWidgets.QTabWidget()
+        if radio:
+            tab_widget = RadioTabWidget()
+        else:
+            tab_widget = QtWidgets.QTabWidget()
+
         for form in forms:
             name = form.name()
             self._widgets[name] = form
@@ -335,6 +352,9 @@ def add_forms(self, forms: Sequence[ParameterForm]) -> QtWidgets.QTabWidget:
             label = utils.title(name)
             tab_widget.addTab(form, label)
 
+            if radio:
+                self._widgets[f'{name}_enabled'] = tab_widget
+
         self.add_widget(tab_widget)
 
         return tab_widget
@@ -524,6 +544,8 @@ def widgets(self) -> dict:
                 widgets[name] = widget
             elif isinstance(widget, CollapsibleBox):
                 widgets[name] = widget
+            elif isinstance(widget, RadioTabWidget):
+                widgets[name] = widget
         return widgets
 
     @staticmethod

qt_parameters/rediotab.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from qt_material_icons import MaterialIcon
+from qtpy import QtWidgets
+
+
+class RadioTabWidget(QtWidgets.QTabWidget):
+    def __init__(self, parent: QtWidgets.QWidget | None = None) -> None:
+        super().__init__(parent)
+
+        self._unchecked_icon = MaterialIcon('radio_button_unchecked')
+        self._checked_icon = MaterialIcon('radio_button_checked')
+
+        self.currentChanged.connect(self._current_changed)
+
+    def tabInserted(self, index: int) -> None:
+        if not self.tabIcon(index):
+            self.setTabIcon(index, self._unchecked_icon)
+
+    def _current_changed(self, index: int) -> None:
+        for i in range(self.count()):
+            if i == index:
+                self.setTabIcon(i, self._checked_icon)
+            else:
+                self.setTabIcon(i, self._unchecked_icon)

tests/editor.py

@@ -57,8 +57,8 @@ def init_ui(self) -> None:
         try:
             parm = StringParameter('string')
             form.add_parameter(parm)
-        except ValueError as e:
-            logging.exception(e)
+        except ValueError:
+            logging.info(f'Unique names validated successfully.')
             self.remove_form(form)
             self.remove_widget(box)
 
@@ -105,6 +105,17 @@ def init_ui(self) -> None:
         # TabWidget
         self.add_forms((multi_form, qt_form))
 
+        # RadioTabWidget
+        form_tab_1 = ParameterForm('tab_1')
+        parm = StringParameter('string')
+        form_tab_1.add_parameter(parm)
+
+        form_tab_2 = ParameterForm('tab_2')
+        parm = StringParameter('string')
+        form_tab_2.add_parameter(parm)
+
+        self.add_forms((form_tab_1, form_tab_2), radio=True)
+
         # Options
         self.add_separator()
 
@@ -144,7 +155,7 @@ def __init__(self, parent: QtWidgets.QWidget | None = None) -> None:
 
     def _init_ui(self) -> None:
         self.setWindowTitle('Parameter Editors')
-        self.resize(640, 720)
+        self.resize(640, 840)
 
         layout = QtWidgets.QHBoxLayout()
         self.setLayout(layout)