Add support for color theme in the "Settings" dialog box

Author: PierreRaybaut

CHANGELOG.md

@@ -25,6 +25,9 @@ See DataLab [roadmap page](https://datalab-platform.com/en/contributing/roadmap.
 * ROI editor:
   * Added toolbars for both Signal and Image ROI editors, to allow to zoom in and out, and to reset the zoom level easily
   * Rearranged the buttons in the ROI editor dialog box for better ergonomics and consistency with the Annotations editor ("View in a new window" dialog box)
+* Application color theme:
+  * Added support for color theme (auto, light, dark) in the "Settings" dialog box
+  * The color theme is applied without restarting the application
 
 🛠️ Bug fixes:
 

cdl/config.py

@@ -94,6 +94,7 @@ class MainSection(conf.Section, metaclass=conf.SectionMeta):
     Each class attribute is an option (metaclass is automatically affecting
     option names in .INI file based on class attribute names)."""
 
+    color_mode = conf.EnumOption(["auto", "dark", "light"])
     process_isolation_enabled = conf.Option()
     rpc_server_enabled = conf.Option()
     rpc_server_port = conf.Option()
@@ -282,6 +283,7 @@ def initialize():
     # options default values are set when used in the application code.
     #
     # Main section
+    Conf.main.color_mode.get("auto")
     Conf.main.process_isolation_enabled.get(True)
     Conf.main.rpc_server_enabled.get(True)
     Conf.main.traceback_log_path.get(f".{APP_NAME}_traceback.log")

cdl/core/gui/main.py

@@ -32,6 +32,7 @@
 from guidata.qthelpers import add_actions, create_action, win32_fix_title_bar_background
 from guidata.widgets.console import DockableConsole
 from plotpy.builder import make
+from plotpy.config import set_plotpy_dark_mode
 from plotpy.constants import PlotType
 from qtpy import QtCore as QC
 from qtpy import QtGui as QG
@@ -132,14 +133,11 @@ def __init__(self, console=None, hide_on_close=False):
         """Initialize main window"""
         CDLMainWindow.__instance = self
         super().__init__()
-        win32_fix_title_bar_background(self)
         self.setObjectName(APP_NAME)
         self.setWindowIcon(get_icon("DataLab.svg"))
 
         execenv.log(self, "Starting initialization")
 
-        self.__restore_pos_and_size()
-
         self.ready_flag = True
 
         self.hide_on_close = hide_on_close
@@ -178,6 +176,8 @@ def __init__(self, console=None, hide_on_close=False):
         self.view_menu: QW.QMenu | None = None
         self.help_menu: QW.QMenu | None = None
 
+        self.__update_color_mode()
+
         self.__is_modified = False
         self.set_modified(False)
 
@@ -192,6 +192,7 @@ def __init__(self, console=None, hide_on_close=False):
             console = Conf.console.console_enabled.get()
         self.setup(console)
 
+        self.__restore_pos_and_size()
         execenv.log(self, "Initialization done")
 
     # ------API related to XML-RPC remote control
@@ -1589,10 +1590,29 @@ def __about(self) -> None:  # pragma: no cover
               <p>{adv_conf}""",
         )
 
+    def __update_color_mode(self) -> None:
+        """Update color mode"""
+        color_mode = Conf.main.color_mode.get()
+        if color_mode != "auto":
+            set_plotpy_dark_mode(color_mode == "dark")
+            if self.docks is not None:
+                for dock in self.docks.values():
+                    widget = dock.widget()
+                    if isinstance(widget, DockablePlotWidget):
+                        widget.update_color_mode()
+            if self.console is not None:
+                self.console.update_color_mode()
+                self.console.clear()
+            if self.macropanel is not None:
+                self.macropanel.update_color_mode()
+        win32_fix_title_bar_background(self)
+
     def __edit_settings(self) -> None:
         """Edit settings"""
         changed_options = edit_settings(self)
         for option in changed_options:
+            if option == "color_mode":
+                self.__update_color_mode()
             if option == "plot_toolbar_position":
                 for dock in self.docks.values():
                     widget = dock.widget()

cdl/core/gui/panel/macro.py

@@ -213,6 +213,13 @@ def __init__(self, parent: QW.QWidget | None = None) -> None:
 
         self.setup_actions()
 
+    def update_color_mode(self) -> None:
+        """Update color mode according to the current theme"""
+        self.console.update_color_mode()
+        self.console.clear()
+        for macro in self.__macros:
+            macro.editor.update_color_mode()
+
     # ------AbstractPanel interface-----------------------------------------------------
     # pylint: disable=unused-argument
     def get_serializable_name(self, obj: Macro) -> str:

cdl/core/gui/settings.py

@@ -26,6 +26,11 @@ class MainSettings(gds.DataSet):
     """DataLab main settings"""
 
     g0 = gds.BeginGroup(_("Settings for main window and general features"))
+    color_mode = gds.ChoiceItem(
+        _("Color mode"),
+        zip(Conf.main.color_mode.choices, Conf.main.color_mode.choices),
+        help=_("Color mode for the application"),
+    )
     process_isolation_enabled = gds.BoolItem(
         "",
         _("Process isolation"),
@@ -297,4 +302,5 @@ def edit_settings(parent: QW.QWidget) -> None:
         for vis_defaults in ("ima_defaults",):
             if getattr(paramdict["view"], vis_defaults):
                 changed_options.append(vis_defaults)
+
     return changed_options

cdl/utils/conf.py

@@ -93,6 +93,27 @@ def remove(self):
         CONF.remove_option(self.section, self.option)
 
 
+class EnumOption(Option):
+    """Enum configuration option handler"""
+
+    def __init__(self, choices: list[str | int | float]) -> None:
+        super().__init__()
+        self.choices = choices
+
+    def get(self, default=NoDefault) -> str | int | float:
+        """Get configuration option value"""
+        value = super().get(default)
+        if value not in self.choices:
+            raise ValueError(f"Invalid configuration option value {value}")
+        return value
+
+    def set(self, value: str | int | float) -> None:
+        """Set configuration option value"""
+        if value not in self.choices:
+            raise ValueError(f"Invalid configuration option value {value}")
+        super().set(value)
+
+
 class ConfigPathOption(Option):
     """Configuration file path configuration option handler"""