Fixes #15 (Part 2): support for dynamic menus on MacOS

Author: PierreRaybaut

cdl/core/gui/main.py

@@ -59,7 +59,7 @@
 from cdl.utils import dephash
 from cdl.utils import qthelpers as qth
 from cdl.utils.misc import go_to_error
-from cdl.utils.qthelpers import bring_to_front
+from cdl.utils.qthelpers import bring_to_front, configure_menu_about_to_show
 from cdl.widgets import instconfviewer, logviewer, status
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -722,7 +722,7 @@ def __setup_global_actions(self) -> None:
         else:
             quit_text = _("Quit")
             quit_tip = _("Quit application")
-        if sys.platform != 'darwin':
+        if sys.platform != "darwin":
             # On macOS, the "Quit" action is automatically added to the application menu
             self.quit_action = create_action(
                 self,
@@ -817,14 +817,14 @@ def __get_local_doc_path() -> str | None:
     def __add_menus(self) -> None:
         """Adding menus"""
         self.file_menu = self.menuBar().addMenu(_("File"))
-        self.file_menu.aboutToShow.connect(self.__update_file_menu)
+        configure_menu_about_to_show(self.file_menu, self.__update_file_menu)
         self.edit_menu = self.menuBar().addMenu(_("&Edit"))
         self.operation_menu = self.menuBar().addMenu(_("Operations"))
         self.processing_menu = self.menuBar().addMenu(_("Processing"))
         self.computing_menu = self.menuBar().addMenu(_("Computing"))
         self.plugins_menu = self.menuBar().addMenu(_("Plugins"))
         self.view_menu = self.menuBar().addMenu(_("&View"))
-        self.view_menu.aboutToShow.connect(self.__update_view_menu)
+        configure_menu_about_to_show(self.view_menu, self.__update_view_menu)
         self.help_menu = self.menuBar().addMenu("?")
         for menu in (
             self.edit_menu,
@@ -833,7 +833,7 @@ def __add_menus(self) -> None:
             self.computing_menu,
             self.plugins_menu,
         ):
-            menu.aboutToShow.connect(self.__update_generic_menu)
+            configure_menu_about_to_show(menu, self.__update_generic_menu)
         help_menu_actions = [
             create_action(
                 self,
@@ -1106,7 +1106,7 @@ def __update_file_menu(self) -> None:
                 self.browseh5_action,
                 None,
                 self.settings_action,
-            ]
+            ],
         )
         if self.quit_action is not None:
             add_actions(self.file_menu, [None, self.quit_action])

cdl/utils/qthelpers.py

@@ -17,7 +17,7 @@
 import shutil
 import sys
 import traceback
-from collections.abc import Generator
+from collections.abc import Callable, Generator
 from contextlib import contextmanager
 from datetime import datetime
 
@@ -323,3 +323,21 @@ def bring_to_front(window: QW.QWidget) -> None:
     # If window is minimized, restore it
     if window.isMinimized():
         window.showNormal()
+
+
+def configure_menu_about_to_show(menu: QW.QMenu, slot: Callable) -> None:
+    """Configure menu about to show.
+    This method is only used to connect the "aboutToShow" signal of menus,
+    and more importantly to fix Issue #15 (Part 2) which is the fact that
+    dynamic menus are not supported on MacOS unless an action is added to
+    the menu before it is displayed.
+
+    Args:
+        menu: menu
+        slot: slot
+    """
+    # On MacOS, add an empty action to the menu before connecting the
+    # "aboutToShow" signal to the slot. This is required to fix Issue #15 (Part 2)
+    if sys.platform == "darwin":
+        menu.addAction(QW.QAction(menu))
+    menu.aboutToShow.connect(slot)