bec-widgets 1.15.1__tar.gz → 1.16.0__tar.gz

{bec_widgets-1.15.1 → bec_widgets-1.16.0}/CHANGELOG.md

@@ -1,6 +1,22 @@
 # CHANGELOG
 
 
+## v1.16.0 (2025-01-14)
+
+### Bug Fixes
+
+- **e2e**: Num of elements to wait for scan fixed to steps requested in the scan
+  ([`0fd5dd5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0fd5dd5a264beb93690365ad8befa34cfdd296d0))
+
+- **toolbar**: Adjusted to future plot base
+  ([`508abfa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/508abfa8a5a31829bdfd5853e967f5ac668d8d8d))
+
+### Features
+
+- **modular_toolbar**: Context menu and action bundles
+  ([`001e6fc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/001e6fc807667187807656a55ab58e3b2f17c9ca))
+
+
 ## v1.15.1 (2025-01-13)
 
 ### Bug Fixes

{bec_widgets-1.15.1 → bec_widgets-1.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.15.1
+Version: 1.16.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-1.15.1 → bec_widgets-1.16.0}/bec_widgets/qt_utils/toolbar.py

@@ -2,17 +2,20 @@
 from __future__ import annotations
 
 import os
+import sys
 from abc import ABC, abstractmethod
 from collections import defaultdict
-from typing import Literal
+from typing import Dict, List, Literal, Tuple
 
 from bec_qthemes._icon.material_icons import material_icon
 from qtpy.QtCore import QSize, Qt
 from qtpy.QtGui import QAction, QColor, QIcon
 from qtpy.QtWidgets import (
+    QApplication,
     QComboBox,
     QHBoxLayout,
     QLabel,
+    QMainWindow,
     QMenu,
     QSizePolicy,
     QToolBar,
@@ -31,7 +34,7 @@ class ToolBarAction(ABC):
 
     Args:
         icon_path (str, optional): The name of the icon file from `assets/toolbar_icons`. Defaults to None.
-        tooltip (bool, optional): The tooltip for the action. Defaults to None.
+        tooltip (str, optional): The tooltip for the action. Defaults to None.
         checkable (bool, optional): Whether the action is checkable. Defaults to False.
     """
 
@@ -81,15 +84,18 @@ class IconAction(ToolBarAction):
         toolbar.addAction(self.action)
 
 
-class MaterialIconAction:
+class MaterialIconAction(ToolBarAction):
     """
     Action with a Material icon for the toolbar.
 
     Args:
-        icon_path (str, optional): The name of the Material icon. Defaults to None.
-        tooltip (bool, optional): The tooltip for the action. Defaults to None.
+        icon_name (str, optional): The name of the Material icon. Defaults to None.
+        tooltip (str, optional): The tooltip for the action. Defaults to None.
         checkable (bool, optional): Whether the action is checkable. Defaults to False.
         filled (bool, optional): Whether the icon is filled. Defaults to False.
+        color (str | tuple | QColor | dict[Literal["dark", "light"], str] | None, optional): The color of the icon.
+            Defaults to None.
+        parent (QWidget or None, optional): Parent widget for the underlying QAction.
     """
 
     def __init__(
@@ -99,30 +105,42 @@ class MaterialIconAction:
         checkable: bool = False,
         filled: bool = False,
         color: str | tuple | QColor | dict[Literal["dark", "light"], str] | None = None,
+        parent=None,
     ):
+        super().__init__(icon_path=None, tooltip=tooltip, checkable=checkable)
         self.icon_name = icon_name
-        self.tooltip = tooltip
-        self.checkable = checkable
-        self.action = None
         self.filled = filled
         self.color = color
-
-    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        icon = self.get_icon()
-        self.action = QAction(icon, self.tooltip, target)
-        self.action.setCheckable(self.checkable)
-        toolbar.addAction(self.action)
-
-    def get_icon(self):
-
-        icon = material_icon(
+        # Generate the icon
+        self.icon = material_icon(
             self.icon_name,
             size=(20, 20),
             convert_to_pixmap=False,
             filled=self.filled,
             color=self.color,
         )
-        return icon
+        # Immediately create an QAction with the given parent
+        self.action = QAction(self.icon, self.tooltip, parent=parent)
+        self.action.setCheckable(self.checkable)
+
+    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
+        """
+        Adds the action to the toolbar.
+
+        Args:
+            toolbar(QToolBar): The toolbar to add the action to.
+            target(QWidget): The target widget for the action.
+        """
+        toolbar.addAction(self.action)
+
+    def get_icon(self):
+        """
+        Returns the icon for the action.
+
+        Returns:
+            QIcon: The icon for the action.
+        """
+        return self.icon
 
 
 class DeviceSelectionAction(ToolBarAction):
@@ -132,7 +150,6 @@ class DeviceSelectionAction(ToolBarAction):
     Args:
         label (str): The label for the combobox.
         device_combobox (DeviceComboBox): The combobox for selecting the device.
-
     """
 
     def __init__(self, label: str, device_combobox):
@@ -160,7 +177,6 @@ class WidgetAction(ToolBarAction):
     Args:
         label (str|None): The label for the widget.
         widget (QWidget): The widget to be added to the toolbar.
-
     """
 
     def __init__(self, label: str | None = None, widget: QWidget = None, parent=None):
@@ -219,7 +235,6 @@ class ExpandableMenuAction(ToolBarAction):
         label (str): The label for the menu.
         actions (dict): A dictionary of actions to populate the menu.
         icon_path (str, optional): The path to the icon file. Defaults to None.
-
     """
 
     def __init__(self, label: str, actions: dict, icon_path: str = None):
@@ -259,6 +274,55 @@ class ExpandableMenuAction(ToolBarAction):
         toolbar.addWidget(button)
 
 
+class ToolbarBundle:
+    """
+    Represents a bundle of toolbar actions, keyed by action_id.
+    Allows direct dictionary-like access: self.actions["some_id"] -> ToolBarAction object.
+    """
+
+    def __init__(self, bundle_id: str = None, actions=None):
+        """
+        Args:
+            bundle_id (str): Unique identifier for the bundle.
+            actions: Either None or a list of (action_id, ToolBarAction) tuples.
+        """
+        self.bundle_id = bundle_id
+        self._actions: dict[str, ToolBarAction] = {}
+
+        # If you passed in a list of tuples, load them into the dictionary
+        if actions is not None:
+            for action_id, action in actions:
+                self._actions[action_id] = action
+
+    def add_action(self, action_id: str, action: ToolBarAction):
+        """
+        Adds or replaces an action in the bundle.
+
+        Args:
+            action_id (str): Unique identifier for the action.
+            action (ToolBarAction): The action to add.
+        """
+        self._actions[action_id] = action
+
+    def remove_action(self, action_id: str):
+        """
+        Removes an action from the bundle by ID.
+        Ignores if not present.
+
+        Args:
+            action_id (str): Unique identifier for the action to remove.
+        """
+        self._actions.pop(action_id, None)
+
+    @property
+    def actions(self) -> dict[str, ToolBarAction]:
+        """
+        Return the internal dictionary of actions so that you can do
+        bundle.actions["drag_mode"] -> ToolBarAction instance.
+        """
+        return self._actions
+
+
 class ModularToolBar(QToolBar):
     """Modular toolbar with optional automatic initialization.
 
@@ -287,10 +351,14 @@ class ModularToolBar(QToolBar):
         # Set the initial orientation
         self.set_orientation(orientation)
 
+        # Initialize bundles
+        self.bundles = {}
+        self.toolbar_items = []
+
         if actions is not None and target_widget is not None:
             self.populate_toolbar(actions, target_widget)
 
-    def populate_toolbar(self, actions: dict, target_widget):
+    def populate_toolbar(self, actions: dict, target_widget: QWidget):
         """Populates the toolbar with a set of actions.
 
         Args:
@@ -298,9 +366,12 @@ class ModularToolBar(QToolBar):
             target_widget (QWidget): The widget that the actions will target.
         """
         self.clear()
+        self.toolbar_items.clear()  # Reset the order tracking
         for action_id, action in actions.items():
             action.add_to_toolbar(self, target_widget)
             self.widgets[action_id] = action
+            self.toolbar_items.append(("action", action_id))
+        self.update_separators()  # Ensure separators are updated after populating
 
     def set_background_color(self, color: str = "rgba(0, 0, 0, 0)"):
         """
@@ -345,7 +416,7 @@ class ModularToolBar(QToolBar):
 
     def add_action(self, action_id: str, action: ToolBarAction, target_widget: QWidget):
         """
-        Adds a new action to the toolbar dynamically.
+        Adds a new standalone action to the toolbar dynamically.
 
         Args:
             action_id (str): Unique identifier for the action.
@@ -356,6 +427,8 @@ class ModularToolBar(QToolBar):
             raise ValueError(f"Action with ID '{action_id}' already exists.")
         action.add_to_toolbar(self, target_widget)
         self.widgets[action_id] = action
+        self.toolbar_items.append(("action", action_id))
+        self.update_separators()  # Update separators after adding the action
 
     def hide_action(self, action_id: str):
         """
@@ -369,6 +442,7 @@ class ModularToolBar(QToolBar):
         action = self.widgets[action_id]
         if hasattr(action, "action") and isinstance(action.action, QAction):
             action.action.setVisible(False)
+            self.update_separators()  # Update separators after hiding the action
 
     def show_action(self, action_id: str):
         """
@@ -382,3 +456,217 @@ class ModularToolBar(QToolBar):
         action = self.widgets[action_id]
         if hasattr(action, "action") and isinstance(action.action, QAction):
             action.action.setVisible(True)
+            self.update_separators()  # Update separators after showing the action
+
+    def add_bundle(self, bundle: ToolbarBundle, target_widget: QWidget):
+        """
+        Adds a bundle of actions to the toolbar, separated by a separator.
+
+        Args:
+            bundle (ToolbarBundle): The bundle to add.
+            target_widget (QWidget): The target widget for the actions.
+        """
+        if bundle.bundle_id in self.bundles:
+            raise ValueError(f"ToolbarBundle with ID '{bundle.bundle_id}' already exists.")
+
+        # Add a separator before the bundle (but not to first one)
+        if self.toolbar_items:
+            sep = SeparatorAction()
+            sep.add_to_toolbar(self, target_widget)
+            self.toolbar_items.append(("separator", None))
+
+        # Add each action in the bundle
+        for action_id, action_obj in bundle.actions.items():
+            action_obj.add_to_toolbar(self, target_widget)
+            self.widgets[action_id] = action_obj
+
+        # Register the bundle
+        self.bundles[bundle.bundle_id] = list(bundle.actions.keys())
+        self.toolbar_items.append(("bundle", bundle.bundle_id))
+
+        self.update_separators()  # Update separators after adding the bundle
+
+    def contextMenuEvent(self, event):
+        """
+        Overrides the context menu event to show a list of toolbar actions with checkboxes and icons, including separators.
+
+        Args:
+            event(QContextMenuEvent): The context menu event.
+        """
+        menu = QMenu(self)
+
+        # Iterate through the toolbar items in order
+        for item_type, identifier in self.toolbar_items:
+            if item_type == "separator":
+                menu.addSeparator()
+            elif item_type == "bundle":
+                self.handle_bundle_context_menu(menu, identifier)
+            elif item_type == "action":
+                self.handle_action_context_menu(menu, identifier)
+
+        # Connect the triggered signal after all actions are added
+        menu.triggered.connect(self.handle_menu_triggered)
+        menu.exec_(event.globalPos())
+
+    def handle_bundle_context_menu(self, menu: QMenu, bundle_id: str):
+        """
+        Adds a set of bundle actions to the context menu.
+
+        Args:
+            menu (QMenu): The context menu to which the actions are added.
+            bundle_id (str): The identifier for the bundle.
+        """
+        action_ids = self.bundles.get(bundle_id, [])
+        for act_id in action_ids:
+            toolbar_action = self.widgets.get(act_id)
+            if not isinstance(toolbar_action, ToolBarAction) or not hasattr(
+                toolbar_action, "action"
+            ):
+                continue
+            qaction = toolbar_action.action
+            if not isinstance(qaction, QAction):
+                continue
+            display_name = qaction.text() or toolbar_action.tooltip or act_id
+            menu_action = QAction(display_name, self)
+            menu_action.setCheckable(True)
+            menu_action.setChecked(qaction.isVisible())
+            menu_action.setData(act_id)  # Store the action_id
+
+            # Set the icon if available
+            if qaction.icon() and not qaction.icon().isNull():
+                menu_action.setIcon(qaction.icon())
+
+            menu.addAction(menu_action)
+
+    def handle_action_context_menu(self, menu: QMenu, action_id: str):
+        """
+        Adds a single toolbar action to the context menu.
+
+        Args:
+            menu (QMenu): The context menu to which the action is added.
+            action_id (str): Unique identifier for the action.
+        """
+        toolbar_action = self.widgets.get(action_id)
+        if not isinstance(toolbar_action, ToolBarAction) or not hasattr(toolbar_action, "action"):
+            return
+        qaction = toolbar_action.action
+        if not isinstance(qaction, QAction):
+            return
+        display_name = qaction.text() or toolbar_action.tooltip or action_id
+        menu_action = QAction(display_name, self)
+        menu_action.setCheckable(True)
+        menu_action.setChecked(qaction.isVisible())
+        menu_action.setData(action_id)  # Store the action_id
+
+        # Set the icon if available
+        if qaction.icon() and not qaction.icon().isNull():
+            menu_action.setIcon(qaction.icon())
+
+        menu.addAction(menu_action)
+
+    def handle_menu_triggered(self, action):
+        """Handles the toggling of toolbar actions from the context menu."""
+        action_id = action.data()
+        if action_id:
+            self.toggle_action_visibility(action_id, action.isChecked())
+
+    def toggle_action_visibility(self, action_id: str, visible: bool):
+        """
+        Toggles the visibility of a specific action on the toolbar.
+
+        Args:
+            action_id(str): Unique identifier for the action to toggle.
+            visible(bool): Whether the action should be visible.
+        """
+        if action_id not in self.widgets:
+            return
+
+        tool_action = self.widgets[action_id]
+        if hasattr(tool_action, "action") and isinstance(tool_action.action, QAction):
+            tool_action.action.setVisible(visible)
+            self.update_separators()
+
+    def update_separators(self):
+        """
+        Hide separators that are adjacent to another separator or have no actions next to them.
+        """
+        toolbar_actions = self.actions()
+
+        for i, action in enumerate(toolbar_actions):
+            if not action.isSeparator():
+                continue
+            # Find the previous visible action
+            prev_visible = None
+            for j in range(i - 1, -1, -1):
+                if toolbar_actions[j].isVisible():
+                    prev_visible = toolbar_actions[j]
+                    break
+
+            # Find the next visible action
+            next_visible = None
+            for j in range(i + 1, len(toolbar_actions)):
+                if toolbar_actions[j].isVisible():
+                    next_visible = toolbar_actions[j]
+                    break
+
+            # Determine if the separator should be hidden
+            # Hide if both previous and next visible actions are separators or non-existent
+            if (prev_visible is None or prev_visible.isSeparator()) and (
+                next_visible is None or next_visible.isSeparator()
+            ):
+                action.setVisible(False)
+            else:
+                action.setVisible(True)
+
+
+class MainWindow(QMainWindow):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("Toolbar / ToolbarBundle Demo")
+
+        self.central_widget = QWidget()
+        self.setCentralWidget(self.central_widget)
+
+        # Create a modular toolbar
+        self.toolbar = ModularToolBar(parent=self, target_widget=self)
+        self.addToolBar(self.toolbar)
+
+        # Example: Add a single bundle
+        home_action = MaterialIconAction(
+            icon_name="home", tooltip="Home", checkable=True, parent=self
+        )
+        settings_action = MaterialIconAction(
+            icon_name="settings", tooltip="Settings", checkable=True, parent=self
+        )
+        profile_action = MaterialIconAction(
+            icon_name="person", tooltip="Profile", checkable=True, parent=self
+        )
+        main_actions_bundle = ToolbarBundle(
+            bundle_id="main_actions",
+            actions=[
+                ("home_action", home_action),
+                ("settings_action", settings_action),
+                ("profile_action", profile_action),
+            ],
+        )
+        self.toolbar.add_bundle(main_actions_bundle, target_widget=self)
+
+        # Another bundle
+        search_action = MaterialIconAction(
+            icon_name="search", tooltip="Search", checkable=True, parent=self
+        )
+        help_action = MaterialIconAction(
+            icon_name="help", tooltip="Help", checkable=True, parent=self
+        )
+        second_bundle = ToolbarBundle(
+            bundle_id="secondary_actions",
+            actions=[("search_action", search_action), ("help_action", help_action)],
+        )
+        self.toolbar.add_bundle(second_bundle, target_widget=self)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    app = QApplication(sys.argv)
+    main_window = MainWindow()
+    main_window.show()
+    sys.exit(app.exec_())

{bec_widgets-1.15.1 → bec_widgets-1.16.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "1.15.1"
+version = "1.16.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [