bec-widgets 1.24.0__tar.gz → 1.24.2__tar.gz

{bec_widgets-1.24.0 → bec_widgets-1.24.2}/CHANGELOG.md

@@ -1,6 +1,39 @@
 # CHANGELOG
 
 
+## v1.24.2 (2025-02-27)
+
+### Bug Fixes
+
+- **e2e**: Added wait time to flaky e2e
+  ([`46b1a22`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/46b1a228be4ef5eb21ecf6c7020a2cd05d06b61a))
+
+
+## v1.24.1 (2025-02-26)
+
+### Bug Fixes
+
+- **plot_base**: Ability to choose between popup or side panel gui mode
+  ([`3aa2f22`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3aa2f2225fba499b648d191ea27553b6db303c18))
+
+- **toolbar**: Switch Actions for default checked actions fixed
+  ([`6d1106e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6d1106e33e1fc3839244b11a601fb71e81a65e61))
+
+### Refactoring
+
+- **axis_settings**: Spinbox migrated to new BECSpinBoxes
+  ([`90a1846`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/90a184643aaaaabaa4feb02d2f406fe2bb9daecc))
+
+- **plot_base**: Toolbar buttons adapted for the Switch actions from toolbar; plot export and mouse
+  modes consolidated into one switch button
+  ([`6f2c240`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6f2c2401ac99b2b8a9af9af76854669a248b516b))
+
+### Testing
+
+- Extended test coverage for axis settings, plot base and qt toolbar action
+  ([`8679b5f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8679b5f08bef8a4a2b6338d9bee4cd70d564f288))
+
+
 ## v1.24.0 (2025-02-26)
 
 ### Bug Fixes

{bec_widgets-1.24.0 → bec_widgets-1.24.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.24.0
+Version: 1.24.2
 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.24.0 → bec_widgets-1.24.2}/bec_widgets/qt_utils/settings_dialog.py

@@ -1,6 +1,6 @@
 from qtpy.QtWidgets import QDialog, QDialogButtonBox, QHBoxLayout, QPushButton, QVBoxLayout, QWidget
 
-from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
+from bec_widgets.qt_utils.error_popups import SafeSlot
 
 
 class SettingWidget(QWidget):
@@ -20,14 +20,14 @@ class SettingWidget(QWidget):
     def set_target_widget(self, target_widget: QWidget):
         self.target_widget = target_widget
 
-    @Slot()
+    @SafeSlot()
     def accept_changes(self):
         """
         Accepts the changes made in the settings widget and applies them to the target widget.
         """
         pass
 
-    @Slot(dict)
+    @SafeSlot(dict)
     def display_current_settings(self, config_dict: dict):
         """
         Displays the current settings of the target widget in the settings widget.
@@ -54,12 +54,13 @@ class SettingsDialog(QDialog):
         settings_widget: SettingWidget = None,
         window_title: str = "Settings",
         config: dict = None,
+        modal: bool = False,
         *args,
         **kwargs,
     ):
         super().__init__(parent, *args, **kwargs)
 
-        self.setModal(False)
+        self.setModal(modal)
 
         self.setWindowTitle(window_title)
 
@@ -92,7 +93,7 @@ class SettingsDialog(QDialog):
         ok_button.setDefault(True)
         ok_button.setAutoDefault(True)
 
-    @Slot()
+    @SafeSlot()
     def accept(self):
         """
         Accept the changes made in the settings widget and close the dialog.
@@ -100,7 +101,7 @@ class SettingsDialog(QDialog):
         self.widget.accept_changes()
         super().accept()
 
-    @Slot()
+    @SafeSlot()
     def apply_changes(self):
         """
         Apply the changes made in the settings widget without closing the dialog.

{bec_widgets-1.24.0 → bec_widgets-1.24.2}/bec_widgets/qt_utils/toolbar.py

@@ -251,6 +251,7 @@ class SwitchableToolBarAction(ToolBarAction):
         initial_action: str = None,
         tooltip: str = None,
         checkable: bool = True,
+        default_state_checked: bool = False,
         parent=None,
     ):
         super().__init__(icon_path=None, tooltip=tooltip, checkable=checkable)
@@ -258,6 +259,7 @@ class SwitchableToolBarAction(ToolBarAction):
         self.current_key = initial_action if initial_action is not None else next(iter(actions))
         self.parent = parent
         self.checkable = checkable
+        self.default_state_checked = default_state_checked
         self.main_button = None
         self.menu_actions: Dict[str, QAction] = {}
 
@@ -283,7 +285,7 @@ class SwitchableToolBarAction(ToolBarAction):
             menu_action.setIconVisibleInMenu(True)
             menu_action.setCheckable(self.checkable)
             menu_action.setChecked(key == self.current_key)
-            menu_action.triggered.connect(lambda checked, k=key: self._set_default_action(k))
+            menu_action.triggered.connect(lambda checked, k=key: self.set_default_action(k))
             menu.addAction(menu_action)
             self.menu_actions[key] = menu_action
         self.main_button.setMenu(menu)
@@ -293,7 +295,7 @@ class SwitchableToolBarAction(ToolBarAction):
         action_obj = self.actions[self.current_key]
         action_obj.action.trigger()
 
-    def _set_default_action(self, key: str):
+    def set_default_action(self, key: str):
         self.current_key = key
         new_action = self.actions[self.current_key]
         self.main_button.setIcon(new_action.get_icon())
@@ -929,7 +931,7 @@ class MainWindow(QMainWindow):  # pragma: no cover
             actions={"action1": action1, "action2": action2},
             initial_action="action1",
             tooltip="Switchable Action",
-            checkable=False,
+            checkable=True,
             parent=self,
         )
         self.toolbar.add_action("switchable_action_no_toggle", switchable_action, self)
@@ -940,6 +942,7 @@ class MainWindow(QMainWindow):  # pragma: no cover
         action2.action.triggered.connect(
             lambda checked: self.test_label.setText(f"Action 2 triggered, checked = {checked}")
         )
+        switchable_action.actions["action1"].action.setChecked(True)
 
     def add_widget_actions(self):
         combo = QComboBox()

{bec_widgets-1.24.0 → bec_widgets-1.24.2}/bec_widgets/widgets/plots_next_gen/plot_base.py

@@ -1,14 +1,18 @@
 from __future__ import annotations
 
+from enum import Enum
+
+import numpy as np
 import pyqtgraph as pg
 from bec_lib import bec_logger
 from qtpy.QtCore import QPoint, QPointF, Qt, Signal
-from qtpy.QtWidgets import QLabel, QVBoxLayout, QWidget
+from qtpy.QtWidgets import QHBoxLayout, QLabel, QMainWindow, QVBoxLayout, QWidget
 
 from bec_widgets.qt_utils.error_popups import SafeProperty, SafeSlot
 from bec_widgets.qt_utils.round_frame import RoundedFrame
+from bec_widgets.qt_utils.settings_dialog import SettingsDialog
 from bec_widgets.qt_utils.side_panel import SidePanel
-from bec_widgets.qt_utils.toolbar import MaterialIconAction, ModularToolBar, SeparatorAction
+from bec_widgets.qt_utils.toolbar import MaterialIconAction, ModularToolBar, ToolbarBundle
 from bec_widgets.utils import ConnectionConfig, Crosshair, EntryValidator
 from bec_widgets.utils.bec_widget import BECWidget
 from bec_widgets.utils.fps_counter import FPSCounter
@@ -20,7 +24,6 @@ from bec_widgets.widgets.plots_next_gen.toolbar_bundles.mouse_interactions impor
 )
 from bec_widgets.widgets.plots_next_gen.toolbar_bundles.plot_export import PlotExportBundle
 from bec_widgets.widgets.plots_next_gen.toolbar_bundles.roi_bundle import ROIBundle
-from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
 
 logger = bec_logger.logger
 
@@ -42,6 +45,12 @@ class BECViewBox(pg.ViewBox):
             self.update()
 
 
+class UIMode(Enum):
+    NONE = 0
+    POPUP = 1
+    SIDE = 2
+
+
 class PlotBase(BECWidget, QWidget):
     PLUGIN = False
     RPC = False
@@ -59,6 +68,7 @@ class PlotBase(BECWidget, QWidget):
         config: ConnectionConfig | None = None,
         client=None,
         gui_id: str | None = None,
+        popups: bool = False,
     ) -> None:
         if config is None:
             config = ConnectionConfig(widget_class=self.__class__.__name__)
@@ -74,6 +84,8 @@ class PlotBase(BECWidget, QWidget):
         self.layout.setContentsMargins(0, 0, 0, 0)
         self.layout.setSpacing(0)
         self.layout_manager = LayoutManagerWidget(parent=self)
+        self.layout_manager.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout_manager.layout.setSpacing(0)
 
         # Property Manager
         self.state_manager = WidgetStateManager(self)
@@ -82,12 +94,14 @@ class PlotBase(BECWidget, QWidget):
         self.entry_validator = EntryValidator(self.dev)
 
         # Base widgets elements
+        self._ui_mode = UIMode.POPUP if popups else UIMode.SIDE
+        self.axis_settings_dialog = None
         self.plot_widget = pg.GraphicsLayoutWidget(parent=self)
         self.plot_item = pg.PlotItem(viewBox=BECViewBox(enableMenu=True))
         self.plot_widget.addItem(self.plot_item)
         self.side_panel = SidePanel(self, orientation="left", panel_max_width=280)
         self.toolbar = ModularToolBar(target_widget=self, orientation="horizontal")
-        self.init_toolbar()
+        self._init_toolbar()
 
         # PlotItem Addons
         self.plot_item.addLegend()
@@ -115,13 +129,14 @@ class PlotBase(BECWidget, QWidget):
         self.layout_manager.add_widget_relative(self.side_panel, self.round_plot_widget, "left")
         self.layout_manager.add_widget_relative(self.toolbar, self.fps_label, "top")
 
-        self.add_side_menus()
+        self.ui_mode = self._ui_mode  # to initiate the first time
 
         # PlotItem ViewBox Signals
         self.plot_item.vb.sigStateChanged.connect(self.viewbox_state_changed)
 
-    def init_toolbar(self):
-
+    def _init_toolbar(self):
+        self.popup_bundle = None
+        self.performance_bundle = ToolbarBundle("performance")
         self.plot_export_bundle = PlotExportBundle("plot_export", target_widget=self)
         self.mouse_bundle = MouseInteractionToolbarBundle("mouse_interaction", target_widget=self)
         # self.state_export_bundle = SaveStateBundle("state_export", target_widget=self) #TODO ATM disabled, cannot be used in DockArea, which is exposed to the user
@@ -133,33 +148,130 @@ class PlotBase(BECWidget, QWidget):
         self.toolbar.add_bundle(self.mouse_bundle, target_widget=self)
         self.toolbar.add_bundle(self.roi_bundle, target_widget=self)
 
-        self.toolbar.add_action("separator_1", SeparatorAction(), target_widget=self)
-        self.toolbar.add_action(
+        self.performance_bundle.add_action(
             "fps_monitor",
-            MaterialIconAction(icon_name="speed", tooltip="Show FPS Monitor", checkable=True),
-            target_widget=self,
+            MaterialIconAction(
+                icon_name="speed", tooltip="Show FPS Monitor", checkable=True, parent=self
+            ),
         )
-        self.toolbar.addWidget(DarkModeButton(toolbar=True))
+        self.toolbar.add_bundle(self.performance_bundle, target_widget=self)
 
         self.toolbar.widgets["fps_monitor"].action.toggled.connect(
             lambda checked: setattr(self, "enable_fps_monitor", checked)
         )
 
+        # hide some options by default
+        self.toolbar.toggle_action_visibility("fps_monitor", False)
+
     def add_side_menus(self):
         """Adds multiple menus to the side panel."""
         # Setting Axis Widget
-        axis_setting = AxisSettings(target_widget=self)
-        self.side_panel.add_menu(
-            action_id="axis",
-            icon_name="settings",
-            tooltip="Show Axis Settings",
-            widget=axis_setting,
-            title="Axis Settings",
+        try:
+            axis_setting = AxisSettings(target_widget=self)
+            self.side_panel.add_menu(
+                action_id="axis",
+                icon_name="settings",
+                tooltip="Show Axis Settings",
+                widget=axis_setting,
+                title="Axis Settings",
+            )
+        except ValueError:
+            return
+
+    def add_popups(self):
+        """
+        Add popups to the toolbar.
+        """
+        self.popup_bundle = ToolbarBundle("popup_bundle")
+        settings = MaterialIconAction(
+            icon_name="settings", tooltip="Show Axis Settings", checkable=True, parent=self
         )
+        self.popup_bundle.add_action("axis", settings)
+        self.toolbar.add_bundle(self.popup_bundle, target_widget=self)
+        self.toolbar.widgets["axis"].action.triggered.connect(self.show_axis_settings_popup)
+
+    def show_axis_settings_popup(self):
+        """
+        Show the axis settings dialog.
+        """
+        settings_action = self.toolbar.widgets["axis"].action
+        if self.axis_settings_dialog is None or not self.axis_settings_dialog.isVisible():
+            axis_setting = AxisSettings(target_widget=self, popup=True)
+            self.axis_settings_dialog = SettingsDialog(
+                self, settings_widget=axis_setting, window_title="Axis Settings", modal=False
+            )
+            # When the dialog is closed, update the toolbar icon and clear the reference
+            self.axis_settings_dialog.finished.connect(self._axis_settings_closed)
+            self.axis_settings_dialog.show()
+            settings_action.setChecked(True)
+        else:
+            # If already open, bring it to the front
+            self.axis_settings_dialog.raise_()
+            self.axis_settings_dialog.activateWindow()
+            settings_action.setChecked(True)  # keep it toggled
+
+    def _axis_settings_closed(self):
+        """
+        Slot for when the axis settings dialog is closed.
+        """
+        self.axis_settings_dialog = None
+        self.toolbar.widgets["axis"].action.setChecked(False)
 
     ################################################################################
     # Toggle UI Elements
     ################################################################################
+    @property
+    def ui_mode(self) -> UIMode:
+        return self._ui_mode
+
+    @ui_mode.setter
+    def ui_mode(self, mode: UIMode):
+        if not isinstance(mode, UIMode):
+            raise ValueError("ui_mode must be an instance of UIMode")
+        self._ui_mode = mode
+
+        # First, clear both UI elements:
+        if self.popup_bundle is not None:
+            for action_id in self.toolbar.bundles["popup_bundle"]:
+                self.toolbar.widgets[action_id].action.setVisible(False)
+            if self.axis_settings_dialog is not None and self.axis_settings_dialog.isVisible():
+                self.axis_settings_dialog.close()
+        self.side_panel.hide()
+
+        # Now, apply the new mode:
+        if mode == UIMode.POPUP:
+            if self.popup_bundle is None:
+                self.add_popups()
+            else:
+                for action_id in self.toolbar.bundles["popup_bundle"]:
+                    self.toolbar.widgets[action_id].action.setVisible(True)
+        elif mode == UIMode.SIDE:
+            self.add_side_menus()
+            self.side_panel.show()
+
+    @SafeProperty(bool, doc="Enable popups setting dialogs for the plot widget.")
+    def enable_popups(self):
+        return self.ui_mode == UIMode.POPUP
+
+    @enable_popups.setter
+    def enable_popups(self, value: bool):
+        if value:
+            self.ui_mode = UIMode.POPUP
+        else:
+            if self.ui_mode == UIMode.POPUP:
+                self.ui_mode = UIMode.NONE
+
+    @SafeProperty(bool, doc="Show Side Panel")
+    def enable_side_panel(self) -> bool:
+        return self.ui_mode == UIMode.SIDE
+
+    @enable_side_panel.setter
+    def enable_side_panel(self, value: bool):
+        if value:
+            self.ui_mode = UIMode.SIDE
+        else:
+            if self.ui_mode == UIMode.SIDE:
+                self.ui_mode = UIMode.NONE
 
     @SafeProperty(bool, doc="Show Toolbar")
     def enable_toolbar(self) -> bool:
@@ -167,15 +279,22 @@ class PlotBase(BECWidget, QWidget):
 
     @enable_toolbar.setter
     def enable_toolbar(self, value: bool):
-        self.toolbar.setVisible(value)
-
-    @SafeProperty(bool, doc="Show Side Panel")
-    def enable_side_panel(self) -> bool:
-        return self.side_panel.isVisible()
-
-    @enable_side_panel.setter
-    def enable_side_panel(self, value: bool):
-        self.side_panel.setVisible(value)
+        if value:
+            # Disable popup mode
+            if self._popups:
+                # Directly update the internal flag to avoid recursion
+                self._popups = False
+            # Hide the popup bundle if it exists and close any open dialogs
+            if self.popup_bundle is not None:
+                for action in self.toolbar.bundles["popup_bundle"].actions:
+                    action.setVisible(False)
+                if self.axis_settings_dialog is not None and self.axis_settings_dialog.isVisible():
+                    self.axis_settings_dialog.close()
+            self.side_panel.show()
+            # Add side menus if not already added
+            self.add_side_menus()
+        else:
+            self.side_panel.hide()
 
     @SafeProperty(bool, doc="Enable the FPS monitor.")
     def enable_fps_monitor(self) -> bool:
@@ -591,16 +710,34 @@ class PlotBase(BECWidget, QWidget):
         item.ctrlMenu.deleteLater()
 
 
+class DemoPlotBase(QMainWindow):  # pragma: no cover:
+    def __init__(self):
+        super().__init__()
+        self.main_widget = QWidget()
+        self.setCentralWidget(self.main_widget)
+        self.main_widget.layout = QHBoxLayout(self.main_widget)
+
+        self.plot_popup = PlotBase(popups=True)
+        self.plot_popup.title = "PlotBase with popups"
+        self.plot_side_panels = PlotBase(popups=False)
+        self.plot_side_panels.title = "PlotBase with side panels"
+
+        self.plot_popup.plot_item.plot(np.random.rand(100), pen=(255, 0, 0))
+        self.plot_side_panels.plot_item.plot(np.random.rand(100), pen=(0, 255, 0))
+
+        self.main_widget.layout.addWidget(self.plot_side_panels)
+        self.main_widget.layout.addWidget(self.plot_popup)
+
+        self.resize(1400, 600)
+
+
 if __name__ == "__main__":  # pragma: no cover:
     import sys
 
     from qtpy.QtWidgets import QApplication
 
     app = QApplication(sys.argv)
-    widget = PlotBase()
-    widget.show()
-    # Just some example data and parameters to test
-    widget.y_grid = True
-    widget.plot_item.plot([1, 2, 3, 4, 5], [1, 2, 3, 4, 5])
+    window = DemoPlotBase()
+    window.show()
 
     sys.exit(app.exec_())

{bec_widgets-1.24.0 → bec_widgets-1.24.2}/bec_widgets/widgets/plots_next_gen/setting_menus/axis_settings.py

@@ -9,7 +9,7 @@ from bec_widgets.utils.widget_io import WidgetIO
 
 
 class AxisSettings(SettingWidget):
-    def __init__(self, parent=None, target_widget=None, *args, **kwargs):
+    def __init__(self, parent=None, target_widget=None, popup=False, *args, **kwargs):
         super().__init__(parent=parent, *args, **kwargs)
 
         # This is a settings widget that depends on the target widget
@@ -18,9 +18,15 @@ class AxisSettings(SettingWidget):
         self.setProperty("skip_settings", True)
         self.setObjectName("AxisSettings")
         current_path = os.path.dirname(__file__)
-        form = UILoader().load_ui(os.path.join(current_path, "axis_settings_vertical.ui"), self)
+        if popup:
+            form = UILoader().load_ui(
+                os.path.join(current_path, "axis_settings_horizontal.ui"), self
+            )
+        else:
+            form = UILoader().load_ui(os.path.join(current_path, "axis_settings_vertical.ui"), self)
 
         self.target_widget = target_widget
+        self.popup = popup
 
         # # Scroll area
         self.scroll_area = QScrollArea(self)
@@ -34,10 +40,13 @@ class AxisSettings(SettingWidget):
         # self.layout.addWidget(self.ui)
         self.ui = form
 
-        self.connect_all_signals()
-        if self.target_widget is not None:
+        if self.target_widget is not None and self.popup is False:
+            self.connect_all_signals()
             self.target_widget.property_changed.connect(self.update_property)
 
+        if self.popup is True:
+            self.fetch_all_properties()
+
     def connect_all_signals(self):
         for widget in [
             self.ui.title,
@@ -93,3 +102,49 @@ class AxisSettings(SettingWidget):
         was_blocked = widget_to_set.blockSignals(True)
         WidgetIO.set_value(widget_to_set, value)
         widget_to_set.blockSignals(was_blocked)
+
+    def fetch_all_properties(self):
+        """
+        Fetch all properties from the target widget and update the settings widget.
+        """
+        for widget in [
+            self.ui.title,
+            self.ui.inner_axes,
+            self.ui.outer_axes,
+            self.ui.x_label,
+            self.ui.x_min,
+            self.ui.x_max,
+            self.ui.x_log,
+            self.ui.x_grid,
+            self.ui.y_label,
+            self.ui.y_min,
+            self.ui.y_max,
+            self.ui.y_log,
+            self.ui.y_grid,
+        ]:
+            property_name = widget.objectName()
+            value = getattr(self.target_widget, property_name)
+            WidgetIO.set_value(widget, value)
+
+    def accept_changes(self):
+        """
+        Apply all properties from the settings widget to the target widget.
+        """
+        for widget in [
+            self.ui.title,
+            self.ui.inner_axes,
+            self.ui.outer_axes,
+            self.ui.x_label,
+            self.ui.x_min,
+            self.ui.x_max,
+            self.ui.x_log,
+            self.ui.x_grid,
+            self.ui.y_label,
+            self.ui.y_min,
+            self.ui.y_max,
+            self.ui.y_log,
+            self.ui.y_grid,
+        ]:
+            property_name = widget.objectName()
+            value = WidgetIO.get_value(widget)
+            setattr(self.target_widget, property_name, value)