bec-widgets 1.21.3__tar.gz → 1.21.4__tar.gz

{bec_widgets-1.21.3 → bec_widgets-1.21.4}/CHANGELOG.md

@@ -1,6 +1,22 @@
 # CHANGELOG
 
 
+## v1.21.4 (2025-02-19)
+
+### Bug Fixes
+
+- **colors**: Pyqtgraph styling updated on the app level
+  ([`ae18279`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ae182796855719437bdf911c2e969e3f438d6982))
+
+- **plot_base**: Mouse interactions default state fetch to toolbar
+  ([`97c0ed5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/97c0ed53df21053fef9811c3dea3b79020137030))
+
+### Refactoring
+
+- **plot_base**: Change the PlotWidget to GraphicalLayoutWidget
+  ([`ff8e282`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ff8e282034f0970b69cf0447fc5f88b4f30bf470))
+
+
 ## v1.21.3 (2025-02-19)
 
 ### Bug Fixes

{bec_widgets-1.21.3 → bec_widgets-1.21.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.21.3
+Version: 1.21.4
 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.21.3 → bec_widgets-1.21.4}/bec_widgets/qt_utils/round_frame.py

@@ -1,6 +1,6 @@
 import pyqtgraph as pg
 from qtpy.QtCore import Property
-from qtpy.QtWidgets import QApplication, QFrame, QVBoxLayout, QWidget
+from qtpy.QtWidgets import QApplication, QFrame, QHBoxLayout, QVBoxLayout, QWidget
 
 from bec_widgets.utils.bec_widget import BECWidget
 from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
@@ -31,22 +31,20 @@ class RoundedFrame(BECWidget, QFrame):
         # Apply rounded frame styling
         self.setProperty("skip_settings", True)
         self.setObjectName("roundedFrame")
-        self.update_style()
 
         # Create a layout for the frame
-        layout = QVBoxLayout(self)
-        layout.setContentsMargins(5, 5, 5, 5)  # Set 5px margin
+        self.layout = QHBoxLayout(self)
+        self.layout.setContentsMargins(5, 5, 5, 5)  # Set 5px margin
 
         # Add the content widget to the layout
         if content_widget:
-            layout.addWidget(content_widget)
+            self.layout.addWidget(content_widget)
 
         # Store reference to the content widget
         self.content_widget = content_widget
 
-        # Automatically apply initial styles to the PlotWidget if applicable
-        if isinstance(content_widget, pg.PlotWidget):
-            self.apply_plot_widget_style()
+        # Automatically apply initial styles to the GraphicalLayoutWidget if applicable
+        self.apply_plot_widget_style()
 
         self._connect_to_theme_change()
 
@@ -65,10 +63,6 @@ class RoundedFrame(BECWidget, QFrame):
 
         self.update_style()
 
-        # Update PlotWidget's background color and axis styles if applicable
-        if isinstance(self.content_widget, pg.PlotWidget):
-            self.apply_plot_widget_style()
-
     @Property(int)
     def radius(self):
         """Radius of the rounded corners."""
@@ -92,6 +86,7 @@ class RoundedFrame(BECWidget, QFrame):
                 }}
             """
             )
+        self.apply_plot_widget_style()
 
     def apply_plot_widget_style(self, border: str = "none"):
         """
@@ -100,35 +95,16 @@ class RoundedFrame(BECWidget, QFrame):
         Args:
             border (str): Border style (e.g., 'none', '1px solid red').
         """
-        if isinstance(self.content_widget, pg.PlotWidget):
-            # Sync PlotWidget's background color with the RoundedFrame's background color
-            self.content_widget.setBackground(self.background_color)
-
-            # Calculate contrast-optimized axis and label colors
-            if self.background_color == "#e9ecef":  # Light mode
-                label_color = "#000000"
-                axis_color = "#666666"
-            else:  # Dark mode
-                label_color = "#FFFFFF"
-                axis_color = "#CCCCCC"
-
-            # Apply axis label and tick colors
-            plot_item = self.content_widget.getPlotItem()
-            for axis in ["left", "right", "top", "bottom"]:
-                plot_item.getAxis(axis).setPen(pg.mkPen(color=axis_color))
-                plot_item.getAxis(axis).setTextPen(pg.mkPen(color=label_color))
-
-            # Change title color
-            plot_item.titleLabel.setText(plot_item.titleLabel.text, color=label_color)
-
+        if isinstance(self.content_widget, pg.GraphicsLayoutWidget):
             # Apply border style via stylesheet
             self.content_widget.setStyleSheet(
                 f"""
-                PlotWidget {{
+                GraphicsLayoutWidget {{
                     border: {border}; /* Explicitly set the border */
                 }}
             """
             )
+            self.content_widget.setBackground(self.background_color)
 
 
 class ExampleApp(QWidget):  # pragma: no cover
@@ -142,26 +118,27 @@ class ExampleApp(QWidget):  # pragma: no cover
         dark_button = DarkModeButton()
 
         # Create PlotWidgets
-        plot1 = pg.PlotWidget()
-        plot1.plot([1, 3, 2, 4, 6, 5], pen="r")
+        plot1 = pg.GraphicsLayoutWidget()
+        plot_item_1 = pg.PlotItem()
+        plot_item_1.plot([1, 3, 2, 4, 6, 5], pen="r")
+        plot1.plot_item = plot_item_1
 
-        plot2 = pg.PlotWidget()
-        plot2.plot([1, 2, 4, 8, 16, 32], pen="r")
+        plot2 = pg.GraphicsLayoutWidget()
+        plot_item_2 = pg.PlotItem()
+        plot_item_2.plot([1, 2, 4, 8, 16, 32], pen="r")
+        plot2.plot_item = plot_item_2
 
         # Wrap PlotWidgets in RoundedFrame
         rounded_plot1 = RoundedFrame(content_widget=plot1, theme_update=True)
         rounded_plot2 = RoundedFrame(content_widget=plot2, theme_update=True)
-        round = RoundedFrame()
 
         # Add to layout
         layout.addWidget(dark_button)
         layout.addWidget(rounded_plot1)
         layout.addWidget(rounded_plot2)
-        layout.addWidget(round)
 
         self.setLayout(layout)
 
-        # Simulate theme change after 2 seconds
         from qtpy.QtCore import QTimer
 
         def change_theme():

{bec_widgets-1.21.3 → bec_widgets-1.21.4}/bec_widgets/utils/bec_widget.py

@@ -66,7 +66,7 @@ class BECWidget(BECConnector):
         if hasattr(qapp, "theme_signal"):
             qapp.theme_signal.theme_updated.connect(self._update_theme)
 
-    def _update_theme(self, theme: str):
+    def _update_theme(self, theme: str | None = None):
         """Update the theme."""
         if theme is None:
             qapp = QApplication.instance()

{bec_widgets-1.21.3 → bec_widgets-1.21.4}/bec_widgets/utils/colors.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import itertools
 import re
 from typing import TYPE_CHECKING, Literal
 
@@ -71,15 +70,64 @@ def apply_theme(theme: Literal["dark", "light"]):
     Apply the theme to all pyqtgraph widgets. Do not use this function directly. Use set_theme instead.
     """
     app = QApplication.instance()
-    # go through all pyqtgraph widgets and set background
-    children = itertools.chain.from_iterable(
-        top.findChildren(pg.GraphicsLayoutWidget) for top in app.topLevelWidgets()
-    )
-    pg.setConfigOptions(
-        foreground="d" if theme == "dark" else "k", background="k" if theme == "dark" else "w"
-    )
-    for pg_widget in children:
-        pg_widget.setBackground("k" if theme == "dark" else "w")
+    graphic_layouts = [
+        child
+        for top in app.topLevelWidgets()
+        for child in top.findChildren(pg.GraphicsLayoutWidget)
+    ]
+
+    plot_items = [
+        item
+        for gl in graphic_layouts
+        for item in gl.ci.items.keys()  # ci is internal pg.GraphicsLayout that hosts all items
+        if isinstance(item, pg.PlotItem)
+    ]
+
+    histograms = [
+        item
+        for gl in graphic_layouts
+        for item in gl.ci.items.keys()  # ci is internal pg.GraphicsLayout that hosts all items
+        if isinstance(item, pg.HistogramLUTItem)
+    ]
+
+    # Update background color based on the theme
+    if theme == "light":
+        background_color = "#e9ecef"  # Subtle contrast for light mode
+        foreground_color = "#141414"
+        label_color = "#000000"
+        axis_color = "#666666"
+    else:
+        background_color = "#141414"  # Dark mode
+        foreground_color = "#e9ecef"
+        label_color = "#FFFFFF"
+        axis_color = "#CCCCCC"
+
+    # update GraphicsLayoutWidget
+    pg.setConfigOptions(foreground=foreground_color, background=background_color)
+    for pg_widget in graphic_layouts:
+        pg_widget.setBackground(background_color)
+
+    # update PlotItems
+    for plot_item in plot_items:
+        for axis in ["left", "right", "top", "bottom"]:
+            plot_item.getAxis(axis).setPen(pg.mkPen(color=axis_color))
+            plot_item.getAxis(axis).setTextPen(pg.mkPen(color=label_color))
+
+        # Change title color
+        plot_item.titleLabel.setText(plot_item.titleLabel.text, color=label_color)
+
+        # Change legend color
+        if hasattr(plot_item, "legend") and plot_item.legend is not None:
+            plot_item.legend.setLabelTextColor(label_color)
+            # if legend is in plot item and theme is changed, has to be like that because of pg opt logic
+            for sample, label in plot_item.legend.items:
+                label_text = label.text
+                label.setText(label_text, color=label_color)
+
+    # update HistogramLUTItem
+    for histogram in histograms:
+        histogram.axis.setPen(pg.mkPen(color=axis_color))
+        histogram.axis.setTextPen(pg.mkPen(color=label_color))
 
     # now define stylesheet according to theme and apply it
     style = bec_qthemes.load_stylesheet(theme)

{bec_widgets-1.21.3 → bec_widgets-1.21.4}/bec_widgets/widgets/plots_next_gen/plot_base.py

@@ -11,7 +11,6 @@ from bec_widgets.qt_utils.side_panel import SidePanel
 from bec_widgets.qt_utils.toolbar import MaterialIconAction, ModularToolBar, SeparatorAction
 from bec_widgets.utils import ConnectionConfig, Crosshair, EntryValidator
 from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.colors import set_theme
 from bec_widgets.utils.fps_counter import FPSCounter
 from bec_widgets.utils.widget_state_manager import WidgetStateManager
 from bec_widgets.widgets.containers.layout_manager.layout_manager import LayoutManagerWidget
@@ -20,7 +19,7 @@ from bec_widgets.widgets.plots_next_gen.toolbar_bundles.mouse_interactions impor
     MouseInteractionToolbarBundle,
 )
 from bec_widgets.widgets.plots_next_gen.toolbar_bundles.plot_export import PlotExportBundle
-from bec_widgets.widgets.plots_next_gen.toolbar_bundles.save_state import SaveStateBundle
+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
@@ -83,8 +82,9 @@ class PlotBase(BECWidget, QWidget):
         self.entry_validator = EntryValidator(self.dev)
 
         # Base widgets elements
+        self.plot_widget = pg.GraphicsLayoutWidget(parent=self)
         self.plot_item = pg.PlotItem(viewBox=BECViewBox(enableMenu=True))
-        self.plot_widget = pg.PlotWidget(plotItem=self.plot_item)
+        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()
@@ -94,13 +94,20 @@ class PlotBase(BECWidget, QWidget):
         self.crosshair = None
         self.fps_monitor = None
         self.fps_label = QLabel(alignment=Qt.AlignmentFlag.AlignRight)
+        self._user_x_label = ""
+        self._x_label_suffix = ""
 
         self._init_ui()
 
+        self._connect_to_theme_change()
+        self._update_theme()
+
+    def apply_theme(self, theme: str):
+        self.round_plot_widget.apply_theme(theme)
+
     def _init_ui(self):
         self.layout.addWidget(self.layout_manager)
         self.round_plot_widget = RoundedFrame(content_widget=self.plot_widget, theme_update=True)
-        self.round_plot_widget.apply_theme("dark")
 
         self.layout_manager.add_widget(self.round_plot_widget)
         self.layout_manager.add_widget_relative(self.fps_label, self.round_plot_widget, "top")
@@ -117,19 +124,15 @@ class PlotBase(BECWidget, QWidget):
 
         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)
+        # self.state_export_bundle = SaveStateBundle("state_export", target_widget=self) #TODO ATM disabled, cannot be used in DockArea, which is exposed to the user
+        self.roi_bundle = ROIBundle("roi", target_widget=self)
 
         # Add elements to toolbar
         self.toolbar.add_bundle(self.plot_export_bundle, target_widget=self)
-        self.toolbar.add_bundle(self.state_export_bundle, target_widget=self)
+        # self.toolbar.add_bundle(self.state_export_bundle, target_widget=self) #TODO ATM disabled, cannot be used in DockArea, which is exposed to the user
         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_0", SeparatorAction(), target_widget=self)
-        self.toolbar.add_action(
-            "crosshair",
-            MaterialIconAction(icon_name="point_scan", tooltip="Show Crosshair", checkable=True),
-            target_widget=self,
-        )
         self.toolbar.add_action("separator_1", SeparatorAction(), target_widget=self)
         self.toolbar.add_action(
             "fps_monitor",
@@ -141,7 +144,6 @@ class PlotBase(BECWidget, QWidget):
         self.toolbar.widgets["fps_monitor"].action.toggled.connect(
             lambda checked: setattr(self, "enable_fps_monitor", checked)
         )
-        self.toolbar.widgets["crosshair"].action.toggled.connect(self.toggle_crosshair)
 
     def add_side_menus(self):
         """Adds multiple menus to the side panel."""
@@ -256,12 +258,45 @@ class PlotBase(BECWidget, QWidget):
 
     @SafeProperty(str, doc="The text of the x label")
     def x_label(self) -> str:
-        return self.plot_item.getAxis("bottom").labelText
+        return self._user_x_label
 
     @x_label.setter
     def x_label(self, value: str):
-        self.plot_item.setLabel("bottom", text=value)
-        self.property_changed.emit("x_label", value)
+        self._user_x_label = value
+        self._apply_x_label()
+        self.property_changed.emit("x_label", self._user_x_label)
+
+    @property
+    def x_label_suffix(self) -> str:
+        """
+        A read-only (or internal) suffix automatically appended to the user label.
+        Not settable by the user directly from the UI.
+        """
+        return self._x_label_suffix
+
+    def set_x_label_suffix(self, suffix: str):
+        """
+        Public or protected method to update the suffix.
+        The user code or subclass (Waveform) can call this
+        when x_mode changes, but the AxisSettings won't show it.
+        """
+        self._x_label_suffix = suffix
+        self._apply_x_label()
+
+    @property
+    def x_label_combined(self) -> str:
+        """
+        The final label shown on the axis = user portion + suffix.
+        """
+        return self._user_x_label + self._x_label_suffix
+
+    def _apply_x_label(self):
+        """
+        Actually updates the pyqtgraph axis label text to
+        the combined label. Called whenever user label or suffix changes.
+        """
+        final_label = self.x_label_combined
+        self.plot_item.setLabel("bottom", text=final_label)
 
     @SafeProperty(str, doc="The text of the y label")
     def y_label(self) -> str:
@@ -545,6 +580,7 @@ class PlotBase(BECWidget, QWidget):
         self.unhook_crosshair()
         self.unhook_fps_monitor(delete_label=True)
         self.cleanup_pyqtgraph()
+        self.rpc_register.remove_rpc(self)
 
     def cleanup_pyqtgraph(self):
         """Cleanup pyqtgraph items."""
@@ -561,7 +597,6 @@ if __name__ == "__main__":  # pragma: no cover:
     from qtpy.QtWidgets import QApplication
 
     app = QApplication(sys.argv)
-    set_theme("dark")
     widget = PlotBase()
     widget.show()
     # Just some example data and parameters to test

{bec_widgets-1.21.3 → bec_widgets-1.21.4}/bec_widgets/widgets/plots_next_gen/toolbar_bundles/mouse_interactions.py

@@ -55,6 +55,27 @@ class MouseInteractionToolbarBundle(ToolbarBundle):
         auto.action.triggered.connect(self.autorange_plot)
         aspect_ratio.action.toggled.connect(self.lock_aspect_ratio)
 
+        mode = self.get_viewbox_mode()
+        if mode == "PanMode":
+            drag.action.setChecked(True)
+        elif mode == "RectMode":
+            rect.action.setChecked(True)
+
+    def get_viewbox_mode(self) -> str:
+        """
+        Returns the current interaction mode of a PyQtGraph ViewBox.
+
+        Returns:
+            str: "PanMode" if pan is enabled, "RectMode" if zoom is enabled, "Unknown" otherwise.
+        """
+        if self.target_widget:
+            viewbox = self.target_widget.plot_item.getViewBox()
+            if viewbox.getState()["mouseMode"] == 3:
+                return "PanMode"
+            elif viewbox.getState()["mouseMode"] == 1:
+                return "RectMode"
+        return "Unknown"
+
     @SafeSlot(bool)
     def enable_mouse_rectangle_mode(self, checked: bool):
         """

bec_widgets-1.21.4/bec_widgets/widgets/plots_next_gen/toolbar_bundles/roi_bundle.py

@@ -0,0 +1,26 @@
+from bec_widgets.qt_utils.toolbar import MaterialIconAction, ToolbarBundle
+
+
+class ROIBundle(ToolbarBundle):
+    """
+    A bundle of actions that are hooked in this constructor itself,
+    so that you can immediately connect the signals and toggle states.
+
+    This bundle is for a toolbar that controls crosshair and ROI interaction.
+    """
+
+    def __init__(self, bundle_id="roi", target_widget=None, **kwargs):
+        super().__init__(bundle_id=bundle_id, actions=[], **kwargs)
+        self.target_widget = target_widget
+
+        # Create each MaterialIconAction with a parent
+        # so the signals can fire even if the toolbar isn't added yet.
+        crosshair = MaterialIconAction(
+            icon_name="point_scan", tooltip="Show Crosshair", checkable=True
+        )
+
+        # Add them to the bundle
+        self.add_action("crosshair", crosshair)
+
+        # Immediately connect signals
+        crosshair.action.toggled.connect(self.target_widget.toggle_crosshair)

{bec_widgets-1.21.3 → bec_widgets-1.21.4}/pyproject.toml

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