bec-widgets 1.6.0__tar.gz → 1.8.0__tar.gz

{bec_widgets-1.6.0 → bec_widgets-1.8.0}/CHANGELOG.md

@@ -1,14 +1,51 @@
 # CHANGELOG
 
 
-## v1.6.0 (2024-11-27)
+## v1.8.0 (2024-12-10)
+
+### Features
+
+- **modular_toolbar**: Material icons can be added/removed/hide/show/update dynamically
+  ([`a55134c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a55134c3bfcbda6dc2d33a17cf5a83df8be3fa7f))
+
+- **modular_toolbar**: Orientation setting
+  ([`5fdb232`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5fdb2325ae970a7ecf4e2f4960710029891ab943))
+
+- **round_frame**: Rounded frame for plot widgets and contrast adjustments
+  ([`6a36ca5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6a36ca512d88f2b4fe916ac991e4f17ae0baffab))
+
+### Testing
+
+- **modular_toolbar**: Tests added
+  ([`9370351`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9370351abbd7a151065ea9300c500d5bea8ee4f6))
+
+
+## v1.7.0 (2024-12-02)
 
 ### Bug Fixes
 
-- **tests**: Make use of BECDockArea with client mixin to start server and use it in tests
-  ([`da18c2c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da18c2ceecf9aeaf0e0ea9b78f4c867b27b9c314))
+- **tests**: Add test for Console widget
+  ([`da579b6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da579b6d213bcdf28c40c1a9e4e2535fdde824fb))
 
-Depending on the test, auto-updates are enabled or not.
+### Features
+
+- **console**: Add "prompt" signal to inform when shell is at prompt
+  ([`3aeb0b6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3aeb0b66fbeb03d3d0ee60e108cc6b98fd9aa9b9))
+
+- **console**: Add 'terminate' and 'send_ctrl_c' methods to Console
+  ([`02086ae`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/02086aeae09233ec4e6ccc0e6a17f2b078d500b8))
+
+.terminate() ends the started process, sending SIGTERM signal. If process is not dead after optional
+  timeout, SIGKILL is sent. .send_ctrl_c() sends SIGINT to the child process, and waits for prompt
+  until optional timeout is reached. Timeouts raise 'TimeoutError' exception.
+
+
+## v1.6.0 (2024-11-27)
+
+### Bug Fixes
+
+- Add back accidentally removed variables
+  ([`e998352`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e9983521ed2a1c04af048a55ece70a1943a84313))
 
 - Differentiate click and drag for DeviceItem, adapt tests accordingly
   ([`cffcdf2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cffcdf292363249bcc7efa9d130431d0bc727fda))
@@ -17,12 +54,6 @@ This fixes the blocking "QDrag.exec_()" on Linux, indeed before the drag'n'drop
   started with a simple click and it was waiting for drop forever. Now there are 2 different cases,
   click or drag'n'drop - the drag'n'drop test actually moves the mouse and releases the button.
 
-- **server**: Use dock area by default
-  ([`2fe7f5e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2fe7f5e1510a5ea72676045e6ea3485e6b11c220))
-
-- **rpc**: Gui hide/show also hide/show all floating docks
-  ([`c27d058`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c27d058b01fe604eccec76454e39360122e48515))
-
 - Do not quit automatically when last window is "closed"
   ([`96e255e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/96e255e4ef394eb79006a66d13e06775ae235667))
 
@@ -31,8 +62,16 @@ Qt confuses closed and hidden
 - No need to call inspect.signature - it can fail on methods coming from C (like Qt methods)
   ([`6029246`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/60292465e9e52d3248ae681c68c07298b9b3ce14))
 
-- Add back accidentally removed variables
-  ([`e998352`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e9983521ed2a1c04af048a55ece70a1943a84313))
+- **rpc**: Gui hide/show also hide/show all floating docks
+  ([`c27d058`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c27d058b01fe604eccec76454e39360122e48515))
+
+- **server**: Use dock area by default
+  ([`2fe7f5e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2fe7f5e1510a5ea72676045e6ea3485e6b11c220))
+
+- **tests**: Make use of BECDockArea with client mixin to start server and use it in tests
+  ([`da18c2c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da18c2ceecf9aeaf0e0ea9b78f4c867b27b9c314))
+
+Depending on the test, auto-updates are enabled or not.
 
 ### Features
 
@@ -40,26 +79,26 @@ Qt confuses closed and hidden
   BECDockArea
   ([`31d8703`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/31d87036c9801e639a7ca6fc003c90e0c4edb19d))
 
-- Add rpc_id member to client objects
-  ([`3ba0b1d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ba0b1daf5b83da840e90fbbc063ed7b86ebe99b))
-
-- **client**: Add show()/hide() methods to "gui" object
-  ([`e68e2b5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e68e2b5978339475b97555c3e20795807932fbc9))
-
-- **server**: Add main window, with proper gui_id derived from given id
-  ([`daf6ea0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/daf6ea0159c9ffc7b53bb7ae6b9abc16a302972c))
+- Add '--hide' argument to BEC GUI server
+  ([`1f60fec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f60fec7201ed252d7e49bf16f2166ee7f6bed6a))
 
 - Add main window container widget
   ([`f80ec33`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f80ec33ae5a261dbcab901ae30f4cc802316e554))
 
+- Add rpc_id member to client objects
+  ([`3ba0b1d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ba0b1daf5b83da840e90fbbc063ed7b86ebe99b))
+
 - Asynchronous .start() for GUI
   ([`2047e48`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2047e484d5a4b2f5ea494a1e49035b35b1bbde35))
 
 - Do not take focus when GUI is loaded
   ([`1f71d8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f71d8e5eded9952f9b34bfc427e2ff44cf5fc18))
 
-- Add '--hide' argument to BEC GUI server
-  ([`1f60fec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f60fec7201ed252d7e49bf16f2166ee7f6bed6a))
+- **client**: Add show()/hide() methods to "gui" object
+  ([`e68e2b5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e68e2b5978339475b97555c3e20795807932fbc9))
+
+- **server**: Add main window, with proper gui_id derived from given id
+  ([`daf6ea0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/daf6ea0159c9ffc7b53bb7ae6b9abc16a302972c))
 
 
 ## v1.5.3 (2024-11-21)
@@ -171,40 +210,3 @@ Qt confuses closed and hidden
 
 - Pyside6 version fixed 6.7.2
   ([`c6e48ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c6e48ec1fe5aaee6a7c7a6f930f1520cd439cdb2))
-
-
-## v1.3.1 (2024-10-31)
-
-### Bug Fixes
-
-- **ophyd_kind_util**: Kind enums are imported from the bec widget util class
-  ([`940ee65`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/940ee6552c1ee8d9b4e4a74c62351f2e133ab678))
-
-
-## v1.3.0 (2024-10-30)
-
-### Bug Fixes
-
-- **colors**: Extend color map validation for matplotlib and colorcet maps (if available)
-  ([`14dd8c5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/14dd8c5b2947c92f6643b888d71975e4e8d4ee88))
-
-### Features
-
-- **colormap_button**: Colormap button with menu to select colormap filtered by the colormap type
-  ([`b039933`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b039933405e2fbe92bd81bd0748e79e8d443a741))
-
-
-## v1.2.0 (2024-10-25)
-
-### Features
-
-- **colors**: Evenly spaced color generation + new golden ratio calculation
-  ([`40c9fea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40c9fea35f869ef52e05948dd1989bcd99f602e0))
-
-### Refactoring
-
-- Add bec_lib version to statusbox
-  ([`5d4b86e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d4b86e1c6e1800051afce4f991153e370767fa6))
-
-
-## v1.1.0 (2024-10-25)

{bec_widgets-1.6.0 → bec_widgets-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 1.6.0
+Version: 1.8.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.6.0 → bec_widgets-1.8.0}/bec_widgets/cli/client.py

@@ -19,7 +19,6 @@ class Widgets(str, enum.Enum):
     BECColorMapWidget = "BECColorMapWidget"
     BECDockArea = "BECDockArea"
     BECImageWidget = "BECImageWidget"
-    BECMainWindow = "BECMainWindow"
     BECMotorMapWidget = "BECMotorMapWidget"
     BECMultiWaveformWidget = "BECMultiWaveformWidget"
     BECProgressBar = "BECProgressBar"
@@ -64,6 +63,13 @@ class AbortButton(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class BECColorMapWidget(RPCBase):
     @property

bec_widgets-1.8.0/bec_widgets/qt_utils/round_frame.py

@@ -0,0 +1,177 @@
+import pyqtgraph as pg
+from qtpy.QtCore import Property
+from qtpy.QtWidgets import QApplication, QFrame, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
+
+
+class RoundedFrame(BECWidget, QFrame):
+    """
+    A custom QFrame with rounded corners and optional theme updates.
+    The frame can contain any QWidget, however it is mainly designed to wrap PlotWidgets to provide a consistent look and feel with other BEC Widgets.
+    """
+
+    def __init__(
+        self,
+        parent=None,
+        content_widget: QWidget = None,
+        background_color: str = None,
+        theme_update: bool = True,
+        radius: int = 10,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        QFrame.__init__(self, parent)
+
+        self.background_color = background_color
+        self.theme_update = theme_update if background_color is None else False
+        self._radius = radius
+
+        # Apply rounded frame styling
+        self.setObjectName("roundedFrame")
+        self.update_style()
+
+        # Create a layout for the frame
+        layout = QVBoxLayout(self)
+        layout.setContentsMargins(5, 5, 5, 5)  # Set 5px margin
+
+        # Add the content widget to the layout
+        if content_widget:
+            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()
+
+        self._connect_to_theme_change()
+
+    def apply_theme(self, theme: str):
+        """
+        Apply the theme to the frame and its content if theme updates are enabled.
+        """
+        if not self.theme_update:
+            return
+
+        # Update background color based on the theme
+        if theme == "light":
+            self.background_color = "#e9ecef"  # Subtle contrast for light mode
+        else:
+            self.background_color = "#141414"  # Dark mode
+
+        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."""
+        return self._radius
+
+    @radius.setter
+    def radius(self, value: int):
+        self._radius = value
+        self.update_style()
+
+    def update_style(self):
+        """
+        Update the style of the frame based on the background color.
+        """
+        if self.background_color:
+            self.setStyleSheet(
+                f"""
+                QFrame#roundedFrame {{
+                    background-color: {self.background_color}; 
+                    border-radius: {self._radius}; /* Rounded corners */
+                }}
+            """
+            )
+
+    def apply_plot_widget_style(self, border: str = "none"):
+        """
+        Automatically apply background, border, and axis styles to the PlotWidget.
+
+        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()
+            plot_item.getAxis("left").setPen(pg.mkPen(color=axis_color))
+            plot_item.getAxis("bottom").setPen(pg.mkPen(color=axis_color))
+            plot_item.getAxis("left").setTextPen(pg.mkPen(color=label_color))
+            plot_item.getAxis("bottom").setTextPen(pg.mkPen(color=label_color))
+
+            # Apply border style via stylesheet
+            self.content_widget.setStyleSheet(
+                f"""
+                PlotWidget {{
+                    border: {border}; /* Explicitly set the border */
+                }}
+            """
+            )
+
+
+class ExampleApp(QWidget):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("Rounded Plots Example")
+
+        # Main layout
+        layout = QVBoxLayout(self)
+
+        dark_button = DarkModeButton()
+
+        # Create PlotWidgets
+        plot1 = pg.PlotWidget()
+        plot1.plot([1, 3, 2, 4, 6, 5], pen="r")
+
+        plot2 = pg.PlotWidget()
+        plot2.plot([1, 2, 4, 8, 16, 32], pen="r")
+
+        # 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():
+            rounded_plot1.apply_theme("light")
+            rounded_plot2.apply_theme("dark")
+
+        QTimer.singleShot(100, change_theme)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    app = QApplication([])
+
+    window = ExampleApp()
+    window.show()
+
+    app.exec()

{bec_widgets-1.6.0 → bec_widgets-1.8.0}/bec_widgets/qt_utils/toolbar.py

@@ -261,17 +261,31 @@ class ExpandableMenuAction(ToolBarAction):
 
 class ModularToolBar(QToolBar):
     """Modular toolbar with optional automatic initialization.
+
     Args:
         parent (QWidget, optional): The parent widget of the toolbar. Defaults to None.
-        actions (list[ToolBarAction], optional): A list of action creators to populate the toolbar. Defaults to None.
+        actions (dict, optional): A dictionary of action creators to populate the toolbar. Defaults to None.
         target_widget (QWidget, optional): The widget that the actions will target. Defaults to None.
+        orientation (Literal["horizontal", "vertical"], optional): The initial orientation of the toolbar. Defaults to "horizontal".
+        background_color (str, optional): The background color of the toolbar. Defaults to "rgba(0, 0, 0, 0)" - transparent background.
     """
 
-    def __init__(self, parent=None, actions: dict | None = None, target_widget=None):
+    def __init__(
+        self,
+        parent=None,
+        actions: dict | None = None,
+        target_widget=None,
+        orientation: Literal["horizontal", "vertical"] = "horizontal",
+        background_color: str = "rgba(0, 0, 0, 0)",
+    ):
         super().__init__(parent)
 
         self.widgets = defaultdict(dict)
-        self.set_background_color()
+        self.background_color = background_color
+        self.set_background_color(self.background_color)
+
+        # Set the initial orientation
+        self.set_orientation(orientation)
 
         if actions is not None and target_widget is not None:
             self.populate_toolbar(actions, target_widget)
@@ -280,7 +294,7 @@ class ModularToolBar(QToolBar):
         """Populates the toolbar with a set of actions.
 
         Args:
-            actions (list[ToolBarAction]): A list of action creators to populate the toolbar.
+            actions (dict): A dictionary of action creators to populate the toolbar.
             target_widget (QWidget): The widget that the actions will target.
         """
         self.clear()
@@ -288,9 +302,83 @@ class ModularToolBar(QToolBar):
             action.add_to_toolbar(self, target_widget)
             self.widgets[action_id] = action
 
-    def set_background_color(self):
+    def set_background_color(self, color: str = "rgba(0, 0, 0, 0)"):
+        """
+        Sets the background color and other appearance settings.
+
+        Args:
+            color(str): The background color of the toolbar.
+        """
         self.setIconSize(QSize(20, 20))
         self.setMovable(False)
         self.setFloatable(False)
         self.setContentsMargins(0, 0, 0, 0)
-        self.setStyleSheet("QToolBar { background-color: rgba(0, 0, 0, 0); border: none; }")
+        self.background_color = color
+        self.setStyleSheet(f"QToolBar {{ background-color: {color}; border: none; }}")
+
+    def set_orientation(self, orientation: Literal["horizontal", "vertical"]):
+        """Sets the orientation of the toolbar.
+
+        Args:
+            orientation (Literal["horizontal", "vertical"]): The desired orientation of the toolbar.
+        """
+        if orientation == "horizontal":
+            self.setOrientation(Qt.Horizontal)
+        elif orientation == "vertical":
+            self.setOrientation(Qt.Vertical)
+        else:
+            raise ValueError("Orientation must be 'horizontal' or 'vertical'.")
+
+    def update_material_icon_colors(self, new_color: str | tuple | QColor):
+        """
+        Updates the color of all MaterialIconAction icons in the toolbar.
+
+        Args:
+            new_color (str | tuple | QColor): The new color for the icons.
+        """
+        for action in self.widgets.values():
+            if isinstance(action, MaterialIconAction):
+                action.color = new_color
+                # Refresh the icon
+                updated_icon = action.get_icon()
+                action.action.setIcon(updated_icon)
+
+    def add_action(self, action_id: str, action: ToolBarAction, target_widget: QWidget):
+        """
+        Adds a new action to the toolbar dynamically.
+
+        Args:
+            action_id (str): Unique identifier for the action.
+            action (ToolBarAction): The action to add to the toolbar.
+            target_widget (QWidget): The target widget for the action.
+        """
+        if action_id in self.widgets:
+            raise ValueError(f"Action with ID '{action_id}' already exists.")
+        action.add_to_toolbar(self, target_widget)
+        self.widgets[action_id] = action
+
+    def hide_action(self, action_id: str):
+        """
+        Hides a specific action on the toolbar.
+
+        Args:
+            action_id (str): Unique identifier for the action to hide.
+        """
+        if action_id not in self.widgets:
+            raise ValueError(f"Action with ID '{action_id}' does not exist.")
+        action = self.widgets[action_id]
+        if hasattr(action, "action") and isinstance(action.action, QAction):
+            action.action.setVisible(False)
+
+    def show_action(self, action_id: str):
+        """
+        Shows a specific action on the toolbar.
+
+        Args:
+            action_id (str): Unique identifier for the action to show.
+        """
+        if action_id not in self.widgets:
+            raise ValueError(f"Action with ID '{action_id}' does not exist.")
+        action = self.widgets[action_id]
+        if hasattr(action, "action") and isinstance(action.action, QAction):
+            action.action.setVisible(True)