bec-widgets 0.99.10__py3-none-any.whl → 0.99.12__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## v0.99.12 (2024-08-29)
+
+### Fix
+
+* fix(toolbar): widget action added ([`2efd487`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2efd48736cbe04e84533f7933c552ea8274e2162))
+
+* fix(reset_button): reset button added ([`6ed1efc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6ed1efc6af193908f70aa37fb73157d2ca6a62f4))
+
+* fix(abort_button): abort button added; some minor fixes ([`a568633`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a568633c3206a8c26069d140f2d9a548bf4124b0))
+
+## v0.99.11 (2024-08-29)
+
+### Fix
+
+* fix(resume_button): resume button added ([`8be8295`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8be8295b2b38f36da210ab36c5da6d0a00e330cc))
+
+### Refactor
+
+* refactor(icons): general app icon changed; jupyter app icon changed to material icon ([`5d73fe4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d73fe455a568ad40a9fadc5ce6e249d782ad20d))
+
+* refactor: add option to select scan and hide arg bundle buttons ([`7dadab1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7dadab1f14aa41876ad39e8cdc7f7732248cc643))
+
 ## v0.99.10 (2024-08-29)
 
 ### Fix
@@ -128,10 +150,6 @@ If not theme is set, the init of the BECWidget base class sets the default theme
 
 ## v0.98.0 (2024-08-25)
 
-### Feature
-
-* feat(themes): added set_theme method ([`2b4449a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2b4449afebdda0a97f95712a1353cf40ec55c283))
-
 ### Fix
 
 * fix(toolbar): removed hardcoded color values ([`afdf4e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/afdf4e8782a22566932180224fa1c924d24c810f))
@@ -142,18 +160,6 @@ If not theme is set, the init of the BECWidget base class sets the default theme
 
 * fix: fix color palette if qtheme was not called ([`3f3b207`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3f3b207295ebd406ebaeecee465c774965161b8b))
 
-* fix(figure): removed theme from figure init ([`e42b84c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e42b84c63650297d67feffccc02a2c2ba111ca79))
-
-* fix: use globally set theme instead of the internal bec widgets theme ([`77c5aa7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/77c5aa741cf1f5b969a42aa878aa2965176dbf41))
-
-* fix(waveform): fixed icon appearance ([`36ad464`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/36ad4641594b67c9b789515c28f7db78a12757ee))
-
 ### Refactor
 
 * refactor(waveform): use set theme for demo ([`44cfda1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/44cfda1c07306669c9a4e09706d95e6b91dee370))
-
-## v0.97.0 (2024-08-23)
-
-### Fix
-
-* fix(toolbar icon): fixed material icon toolbar for theme changes ([`3ecbd60`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ecbd60627994417c9175364e5909710dbcdceb2))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.99.10
+Version: 0.99.12
 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/cli/client.py

@@ -13,6 +13,7 @@ class Widgets(str, enum.Enum):
     Enum for the available widgets.
     """
 
+    AbortButton = "AbortButton"
     BECDock = "BECDock"
     BECDockArea = "BECDockArea"
     BECFigure = "BECFigure"
@@ -27,6 +28,8 @@ class Widgets(str, enum.Enum):
     DeviceLineEdit = "DeviceLineEdit"
     PositionerBox = "PositionerBox"
     PositionerControlLine = "PositionerControlLine"
+    ResetButton = "ResetButton"
+    ResumeButton = "ResumeButton"
     RingProgressBar = "RingProgressBar"
     ScanControl = "ScanControl"
     StopButton = "StopButton"
@@ -35,6 +38,24 @@ class Widgets(str, enum.Enum):
     WebsiteWidget = "WebsiteWidget"
 
 
+class AbortButton(RPCBase):
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+
 class BECCurve(RPCBase):
     @rpc_call
     def remove(self):
@@ -2373,7 +2394,7 @@ class DeviceLineEdit(RPCBase):
 
 class PositionerBox(RPCBase):
     @rpc_call
-    def set_positioner(self, positioner: str):
+    def set_positioner(self, positioner: "str | Positioner"):
         """
         Set the device
 
@@ -2384,7 +2405,7 @@ class PositionerBox(RPCBase):
 
 class PositionerControlLine(RPCBase):
     @rpc_call
-    def set_positioner(self, positioner: str):
+    def set_positioner(self, positioner: "str | Positioner"):
         """
         Set the device
 
@@ -2393,6 +2414,42 @@ class PositionerControlLine(RPCBase):
         """
 
 
+class ResetButton(RPCBase):
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+
+class ResumeButton(RPCBase):
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+
 class Ring(RPCBase):
     @rpc_call
     def _get_all_rpc(self) -> "dict":

bec_widgets/examples/general_app/general_app.py

@@ -80,7 +80,7 @@ def main():  # pragma: no cover
     app = QApplication(sys.argv)
     icon = QIcon()
     icon.addFile(
-        os.path.join(MODULE_PATH, "assets", "app_icons", "BEC-Dark.png"), size=QSize(48, 48)
+        os.path.join(MODULE_PATH, "assets", "app_icons", "BEC-General-App.png"), size=QSize(48, 48)
     )
     app.setWindowIcon(icon)
     main_window = BECGeneralApp()

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -2,6 +2,7 @@ import os
 
 import numpy as np
 import pyqtgraph as pg
+from bec_qthemes import material_icon
 from qtpy.QtCore import QSize
 from qtpy.QtGui import QIcon
 from qtpy.QtWidgets import (
@@ -200,10 +201,7 @@ if __name__ == "__main__":  # pragma: no cover
     app.setApplicationName("Jupyter Console")
     app.setApplicationDisplayName("Jupyter Console")
     apply_theme("dark")
-    icon = QIcon()
-    icon.addFile(
-        os.path.join(module_path, "assets", "app_icons", "terminal_icon.png"), size=QSize(48, 48)
-    )
+    icon = material_icon("terminal", color="#434343", filled=True)
     app.setWindowIcon(icon)
 
     bec_dispatcher = BECDispatcher()

bec_widgets/qt_utils/toolbar.py

@@ -142,6 +142,31 @@ class DeviceSelectionAction(ToolBarAction):
         self.device_combobox.setStyleSheet(f"QComboBox {{ background-color: {color}; }}")
 
 
+class WidgetAction(ToolBarAction):
+    """
+    Action for adding any widget to the toolbar.
+
+    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):
+        super().__init__()
+        self.label = label
+        self.widget = widget
+
+    def add_to_toolbar(self, toolbar, target):
+        widget = QWidget()
+        layout = QHBoxLayout(widget)
+        if self.label is not None:
+            label = QLabel(f"{self.label}")
+            layout.addWidget(label)
+        layout.addWidget(self.widget)
+        toolbar.addWidget(widget)
+
+
 class ExpandableMenuAction(ToolBarAction):
     """
     Action for an expandable menu in the toolbar.

bec_widgets/widgets/button_abort/abort_button.pyproject

@@ -0,0 +1 @@
+{'files': ['button_abort.py']}

bec_widgets/widgets/button_abort/abort_button_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.button_abort.button_abort import AbortButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='AbortButton' name='abort_button'>
+    </widget>
+</ui>
+"""
+
+
+class AbortButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = AbortButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(AbortButton.ICON_NAME)
+
+    def includeFile(self):
+        return "abort_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "AbortButton"
+
+    def toolTip(self):
+        return "A button that abort the scan."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/button_abort/button_abort.py

@@ -0,0 +1,49 @@
+from bec_qthemes import material_icon
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot
+from bec_widgets.utils.bec_widget import BECWidget
+
+
+class AbortButton(BECWidget, QWidget):
+    """A button that abort the scan."""
+
+    ICON_NAME = "cancel"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None, toolbar=False):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        self.get_bec_shortcuts()
+
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        if toolbar:
+            icon = material_icon("cancel", color="#666666", filled=True)
+            self.button = QToolButton(icon=icon)
+            self.button.triggered.connect(self.abort_scan)
+        else:
+            self.button = QPushButton()
+            self.button.setText("Abort")
+            self.button.setStyleSheet(
+                "background-color:  #666666; color: white; font-weight: bold; font-size: 12px;"
+            )
+            self.button.clicked.connect(self.abort_scan)
+
+        self.layout.addWidget(self.button)
+
+    @SafeSlot()
+    def abort_scan(
+        self,
+    ):  # , scan_id: str | None = None): #FIXME scan_id will be added when combining with Queue widget
+        """
+        Abort the scan.
+
+        Args:
+            scan_id(str|None): The scan id to abort. If None, the current scan will be aborted.
+        """
+        self.queue.request_scan_abortion()

bec_widgets/widgets/button_abort/register_abort_button.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.button_abort.abort_button_plugin import AbortButtonPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(AbortButtonPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/button_reset/button_reset.py

@@ -0,0 +1,42 @@
+from bec_qthemes import material_icon
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot
+from bec_widgets.utils.bec_widget import BECWidget
+
+
+class ResetButton(BECWidget, QWidget):
+    """A button that reset the scan queue."""
+
+    ICON_NAME = "restart_alt"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None, toolbar=False):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        self.get_bec_shortcuts()
+
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        if toolbar:
+            icon = material_icon("restart_alt", color="#F19E39", filled=True)
+            self.button = QToolButton(icon=icon)
+            self.button.triggered.connect(self.reset_queue)
+        else:
+            self.button = QPushButton()
+            self.button.setText("Reset Queue")
+            self.button.setStyleSheet(
+                "background-color:  #F19E39; color: white; font-weight: bold; font-size: 12px;"
+            )
+            self.button.clicked.connect(self.reset_queue)
+
+        self.layout.addWidget(self.button)
+
+    @SafeSlot()
+    def reset_queue(self):
+        """Stop the scan."""
+        self.queue.request_queue_reset()

bec_widgets/widgets/button_reset/register_reset_button.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.button_reset.reset_button_plugin import ResetButtonPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ResetButtonPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/button_reset/reset_button.pyproject

@@ -0,0 +1 @@
+{'files': ['button_reset.py']}

bec_widgets/widgets/button_reset/reset_button_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.button_reset.button_reset import ResetButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ResetButton' name='reset_button'>
+    </widget>
+</ui>
+"""
+
+
+class ResetButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ResetButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(ResetButton.ICON_NAME)
+
+    def includeFile(self):
+        return "reset_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "ResetButton"
+
+    def toolTip(self):
+        return "A button that reset the scan queue."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/button_resume/button_resume.py

@@ -0,0 +1,42 @@
+from bec_qthemes import material_icon
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot
+from bec_widgets.utils.bec_widget import BECWidget
+
+
+class ResumeButton(BECWidget, QWidget):
+    """A button that continue scan queue."""
+
+    ICON_NAME = "resume"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None, toolbar=False):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        self.get_bec_shortcuts()
+
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        if toolbar:
+            icon = material_icon("resume", color="#2793e8", filled=True)
+            self.button = QToolButton(icon=icon)
+            self.button.triggered.connect(self.continue_scan)
+        else:
+            self.button = QPushButton()
+            self.button.setText("Resume")
+            self.button.setStyleSheet(
+                "background-color:  #2793e8; color: white; font-weight: bold; font-size: 12px;"
+            )
+            self.button.clicked.connect(self.continue_scan)
+
+        self.layout.addWidget(self.button)
+
+    @SafeSlot()
+    def continue_scan(self):
+        """Stop the scan."""
+        self.queue.request_scan_continuation()

bec_widgets/widgets/button_resume/register_resume_button.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.button_resume.resume_button_plugin import ResumeButtonPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ResumeButtonPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/button_resume/resume_button.pyproject

@@ -0,0 +1 @@
+{'files': ['button_resume.py']}

bec_widgets/widgets/button_resume/resume_button_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.button_resume.button_resume import ResumeButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ResumeButton' name='resume_button'>
+    </widget>
+</ui>
+"""
+
+
+class ResumeButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ResumeButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(ResumeButton.ICON_NAME)
+
+    def includeFile(self):
+        return "resume_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "ResumeButton"
+
+    def toolTip(self):
+        return "A button that continue scan queue."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/positioner_box/positioner_box.py

@@ -1,5 +1,7 @@
 """ Module for a PositionerBox widget to control a positioner device."""
 
+from __future__ import annotations
+
 import os
 import uuid
 

bec_widgets/widgets/scan_control/scan_control.py

@@ -126,12 +126,43 @@ class ScanControl(BECWidget, QWidget):
         selected_scan_name = self.comboBox_scan_selection.currentText()
         self.scan_selected.emit(selected_scan_name)
 
+    @Property(str)
+    def current_scan(self):
+        """Returns the scan name for the currently selected scan."""
+        return self.comboBox_scan_selection.currentText()
+
+    @current_scan.setter
+    def current_scan(self, scan_name: str):
+        """Sets the current scan to the given scan name.
+
+        Args:
+            scan_name(str): Name of the scan to set as current.
+        """
+        if scan_name not in self.available_scans:
+            return
+        self.comboBox_scan_selection.setCurrentText(scan_name)
+
+    @Slot(str)
+    def set_current_scan(self, scan_name: str):
+        """Slot for setting the current scan to the given scan name.
+
+        Args:
+            scan_name(str): Name of the scan to set as current.
+        """
+        self.current_scan = scan_name
+
     @Property(bool)
     def hide_scan_control_buttons(self):
+        """Property to hide the scan control buttons."""
         return not self.button_run_scan.isVisible()
 
     @hide_scan_control_buttons.setter
     def hide_scan_control_buttons(self, hide: bool):
+        """Setter for the hide_scan_control_buttons property.
+
+        Args:
+            hide(bool): Hide or show the scan control buttons.
+        """
         self.show_scan_control_buttons(not hide)
 
     @Slot(bool)
@@ -145,10 +176,16 @@ class ScanControl(BECWidget, QWidget):
 
     @Property(bool)
     def hide_scan_selection_combobox(self):
+        """Property to hide the scan selection combobox."""
         return not self.comboBox_scan_selection.isVisible()
 
     @hide_scan_selection_combobox.setter
     def hide_scan_selection_combobox(self, hide: bool):
+        """Setter for the hide_scan_selection_combobox property.
+
+        Args:
+            hide(bool): Hide or show the scan selection combobox.
+        """
         self.show_scan_selection_combobox(not hide)
 
     @Slot(bool)
@@ -176,8 +213,7 @@ class ScanControl(BECWidget, QWidget):
 
         show_bundle_buttons = bool(self.arg_group["arg_inputs"])
 
-        self.button_add_bundle.setVisible(show_bundle_buttons)
-        self.button_remove_bundle.setVisible(show_bundle_buttons)
+        self._show_bundle_buttons(show_bundle_buttons)
 
         if show_bundle_buttons:
             self.add_arg_group(self.arg_group)
@@ -187,6 +223,29 @@ class ScanControl(BECWidget, QWidget):
         self.update()
         self.adjustSize()
 
+    def _show_bundle_buttons(self, show: bool):
+        """Shows or hides the bundle buttons based on the show argument.
+
+        Args:
+            show(bool): Show or hide the bundle buttons.
+        """
+        self.button_add_bundle.setVisible(show)
+        self.button_remove_bundle.setVisible(show)
+
+    @Property(bool)
+    def hide_bundle_buttons(self):
+        """Property to hide the bundle buttons."""
+        return not self.button_add_bundle.isVisible()
+
+    @hide_bundle_buttons.setter
+    def hide_bundle_buttons(self, hide: bool):
+        """Setter for the hide_bundle_buttons property.
+
+        Args:
+            hide(bool): Hide or show the bundle buttons.
+        """
+        self._show_bundle_buttons(not hide)
+
     def add_kwargs_boxes(self, groups: list):
         """
         Adds the given gui_groups to the scan control layout.
@@ -212,10 +271,12 @@ class ScanControl(BECWidget, QWidget):
 
     @Slot()
     def add_arg_bundle(self):
+        """Adds a new argument bundle to the scan control layout."""
         self.arg_box.add_widget_bundle()
 
     @Slot()
     def remove_arg_bundle(self):
+        """Removes the last argument bundle from the scan control layout."""
         self.arg_box.remove_widget_bundle()
 
     def reset_layout(self):
@@ -235,6 +296,7 @@ class ScanControl(BECWidget, QWidget):
 
     @Slot()
     def run_scan(self):
+        """Starts the selected scan with the given parameters."""
         self.scan_started.emit()
         args = []
         kwargs = {}
@@ -248,6 +310,7 @@ class ScanControl(BECWidget, QWidget):
             scan_function(*args, **kwargs)
 
     def cleanup(self):
+        """Cleanup the scan control widget."""
         self.button_stop_scan.cleanup()
         if self.arg_box:
             for widget in self.arg_box.widgets:

bec_widgets/widgets/stop_button/stop_button.py

@@ -23,9 +23,7 @@ class StopButton(BECWidget, QWidget):
         self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
 
         if toolbar:
-            icon = material_icon(
-                "stop", size=(20, 20), color="#cc181e", filled=True, convert_to_pixmap=False
-            )
+            icon = material_icon("stop", color="#cc181e", filled=True)
             self.button = QToolButton(icon=icon)
             self.button.triggered.connect(self.stop_scan)
         else:
@@ -39,6 +37,13 @@ class StopButton(BECWidget, QWidget):
         self.layout.addWidget(self.button)
 
     @SafeSlot()
-    def stop_scan(self):
-        """Stop the scan."""
+    def stop_scan(
+        self,
+    ):  # , scan_id: str | None = None): #FIXME scan_id will be added when combining with Queue widget
+        """
+        Stop the scan.
+
+        Args:
+            scan_id(str|None): The scan id to stop. If None, the current scan will be stopped.
+        """
         self.queue.request_scan_halt()

bec_widgets/widgets/stop_button/stop_button_plugin.py

@@ -31,7 +31,7 @@ class StopButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return "BEC Utils"
+        return "BEC Buttons"
 
     def icon(self):
         return designer_material_icon(StopButton.ICON_NAME)

{bec_widgets-0.99.10.dist-info → bec_widgets-0.99.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.99.10
+Version: 0.99.12
 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-0.99.10.dist-info → bec_widgets-0.99.12.dist-info}/RECORD

@@ -2,20 +2,19 @@
 .gitlab-ci.yml,sha256=HE_stq5wl-0wE5ZetfEmaaDbectk20jX7Z2cxwsBegg,8348
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=8YPpCwOpu5V6FgaplOkX0H_LvOWYNXwuJyKAtAueZ1Y,6862
+CHANGELOG.md,sha256=6c9TNioj6VAiLpKefbh4exckHJCVVPUQqjFqFq0F9Q0,7069
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=JQ0kq0C_gndkxeyqnay6w3QQyYb8ShQvxfkqEH3Rd4Q,1334
+PKG-INFO,sha256=meqZoR4X-i0IEv8GXcSeCQBGzHpF6CdYR9oCul-5syA,1334
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=monX0rBwlphrV8Hyu2hYn4hMDQ4DIYl0-KpKCqpJfiA,2544
+pyproject.toml,sha256=8epLbMmPD9IdOXkD8j_T6lAGr8Lkf_QX-6Nz1gUKzX0,2544
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
 .gitlab/issue_templates/feature_request_template.md,sha256=vjxCnmj53Mp4FPzCrNxhkO-8StRQUZ36PlXu4K8VGaI,1543
 .gitlab/merge_request_templates/default.md,sha256=tfyFA0hRCsIunbLGSlGbxWBQFeB3USpsA3H7IvwQ5UY,715
 bec_widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/assets/app_icons/BEC-Dark.png,sha256=TUebkoQX26eY7CIbXXVzyen5rph0loTQot7FfqWzsQs,1683654
+bec_widgets/assets/app_icons/BEC-General-App.png,sha256=hc2ktly53DZAbl_rE3cb-vdRa5gtdCmBEjfwm2y5P4g,447581
 bec_widgets/assets/app_icons/bec_widgets_icon.png,sha256=K8dgGwIjalDh9PRHUsSQBqgdX7a00nM3igZdc20pkYM,1747017
-bec_widgets/assets/app_icons/terminal_icon.png,sha256=bJl7Tft4Fi2uxvuXI8o14uMHnI9eAWKSU2uftXCH9ws,3889
 bec_widgets/assets/status_icons/error.svg,sha256=U_-8qDHAeCH8Z9sUXoU5zSPf0RyVx-CAWK6h2gH99C4,718
 bec_widgets/assets/status_icons/not_connected.svg,sha256=wuNdFzNHuZrd_pguRi-mUw3l6uRSkb37yGFJ6kKyMQo,721
 bec_widgets/assets/status_icons/refresh.svg,sha256=Em_236ARgCdkSof-HU5EYGwv2hXPhOH0NYj2mKaIrwI,559
@@ -23,7 +22,7 @@ bec_widgets/assets/status_icons/running.svg,sha256=nlc6rKh_f-uOxQSk0BkBNyWnPAJU5
 bec_widgets/assets/status_icons/warning.svg,sha256=CNx88p9kbDG51s9ztKf-cfYan4JdDBbk3-IFKfOOFlI,364
 bec_widgets/cli/__init__.py,sha256=d0Q6Fn44e7wFfLabDOBxpcJ1DPKWlFunGYDUBmO-4hA,22
 bec_widgets/cli/auto_updates.py,sha256=DwzRChcFIWPH2kCYvp8H7dXvyYSKGYv6LwCmK2sDR2E,5676
-bec_widgets/cli/client.py,sha256=M0o5UVEaj7H4hpmHXNFBXuDCTrTtWmip5Lhj2bjys88,76916
+bec_widgets/cli/client.py,sha256=Go09tb7lnsDSljF-7rtWu4x8x_ooL-F4WWuu_yFaTNA,78098
 bec_widgets/cli/client_utils.py,sha256=l35LtTkD7PdvVCckjMU8-y6f5a5pp1u6cFPpD-Dkvow,11713
 bec_widgets/cli/generate_cli.py,sha256=Ea5px9KblUlcGg-1JbJBTIU7laGg2n8PM7Efw9WVVzM,5889
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
@@ -31,11 +30,11 @@ bec_widgets/cli/rpc_wigdet_handler.py,sha256=6kQng2DyS6rhLJqSJ7xa0kdgSxp-35A2upc
 bec_widgets/cli/server.py,sha256=I3gZ5xwygEOnL4ga3zOoD3jRUXNjPRop4u7a0emfejs,7921
 bec_widgets/examples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/examples/general_app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/examples/general_app/general_app.py,sha256=Ks9CKtIQIFOzKosh204zVg1ltSnp07LDqkwoVAaCd9k,3046
+bec_widgets/examples/general_app/general_app.py,sha256=PoFCTuA_1yqrpgthASpYFgH7JDUZTcXAPZ5h0e3XZfc,3053
 bec_widgets/examples/general_app/general_app.ui,sha256=TsejkM3Z8znnixyqxoj4SwhIIpIzTAuGAMkGXSS1aT8,10479
 bec_widgets/examples/general_app/web_links.py,sha256=d5OgzgI9zb-NAC0pOGanOtJX3nZoe4x8QuQTw-_hK_8,434
 bec_widgets/examples/jupyter_console/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/examples/jupyter_console/jupyter_console_window.py,sha256=2PDhUevxU5YlZcoVokH5fgGdwFGIQFSN8x0DChhxoxE,6803
+bec_widgets/examples/jupyter_console/jupyter_console_window.py,sha256=C1GeB-RuL7Uo2IJS8DghNsPY41FJJi60EVXVJrwz3Do,6767
 bec_widgets/examples/plugin_example_pyside/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/examples/plugin_example_pyside/main.py,sha256=zDP5wO7wb3BVsQ15HOCRT1nNmCujIVRvSXZ3Txje8L0,549
 bec_widgets/examples/plugin_example_pyside/registertictactoe.py,sha256=cVhBnP0qx5j9Jft-VeKvlTFE-bX58hbP45CX0f4r5pM,535
@@ -47,7 +46,7 @@ bec_widgets/qt_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hS
 bec_widgets/qt_utils/error_popups.py,sha256=y9gKKWaafp468ioHr96nBhf02ZpEgjDc-BAVOTWh-e8,7680
 bec_widgets/qt_utils/redis_message_waiter.py,sha256=fvL_QgC0cTDv_FPJdRyp5AKjf401EJU4z3r38p47ydY,1745
 bec_widgets/qt_utils/settings_dialog.py,sha256=NhtzTer_xzlB2lLLrGklkI1QYLJEWQpJoZbCz4o5daI,3645
-bec_widgets/qt_utils/toolbar.py,sha256=9TEthLa3ijoXl7njMyWhXvDYP2Jr9DFZNEd5D3L52X0,7806
+bec_widgets/qt_utils/toolbar.py,sha256=NhpXw5An2qNefv0iQdCyDUbkanPcsQoD_8vDOGhQEOs,8494
 bec_widgets/utils/__init__.py,sha256=1930ji1Jj6dVuY81Wd2kYBhHYNV-2R0bN_L4o9zBj1U,533
 bec_widgets/utils/bec_connector.py,sha256=SivHKXVyNVqeu3kCXYEPpbleTVw8g1cW0FKq1QrQgco,9987
 bec_widgets/utils/bec_designer.py,sha256=Z3MeMju-KmTz8POtm23VQfp4rvtD2sF6eIOKQkl2F7w,4729
@@ -84,6 +83,21 @@ bec_widgets/widgets/bec_status_box/bec_status_box.pyproject,sha256=JWtx3Csfn2h7O
 bec_widgets/widgets/bec_status_box/bec_status_box_plugin.py,sha256=UmsXAmeHg7FRkzirOLBPi3LwbRbG75w8LglYt4jn6Fc,1412
 bec_widgets/widgets/bec_status_box/register_bec_status_box.py,sha256=EiQITnkNw7IU7hE776wAeXro97eZd9XlsB9essgCebE,481
 bec_widgets/widgets/bec_status_box/status_item.py,sha256=3aNaa-e64PmkBoAWfItYAmhB1EFhWRiFLzXWWz0dS_8,5317
+bec_widgets/widgets/button_abort/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/widgets/button_abort/abort_button.pyproject,sha256=UtuaE0Lvs6uOGufhatUyJS_n2l6EBbYaGuILj_BNCLs,30
+bec_widgets/widgets/button_abort/abort_button_plugin.py,sha256=3q0a4UE2O9s96Jjg6wi03CpXdQ7CnOI20ep7etEdxMo,1285
+bec_widgets/widgets/button_abort/button_abort.py,sha256=TpmxyG3GP-4RWTDJ9gSLyoD8aOYGJRzLC65fpxNSJTE,1688
+bec_widgets/widgets/button_abort/register_abort_button.py,sha256=IthCqJIaCR25ELRqMssSzve_7CE8G54wDlBVY0gPSNI,475
+bec_widgets/widgets/button_reset/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/widgets/button_reset/button_reset.py,sha256=AnWC6i1j7yVudmX6FKGOZBNd5KKmhvl7DzDKYKxLwxg,1470
+bec_widgets/widgets/button_reset/register_reset_button.py,sha256=IuCaPrqKqF9acVBL2k1St0exsb3rwQF_Y1-QciDEVjw,475
+bec_widgets/widgets/button_reset/reset_button.pyproject,sha256=JC7XLsjgYzTAh6BV3KmxtT3w4ZUH91wiqIeGefnCjMk,30
+bec_widgets/widgets/button_reset/reset_button_plugin.py,sha256=QW4ToNqnwh55hN6GMAId1C65vkPYRTAoPTWcXRFvWLw,1291
+bec_widgets/widgets/button_resume/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/widgets/button_resume/button_resume.py,sha256=MH6JqiA2GkModbS0EC0_k5cYHIVVkuY9P3hylYLYfE0,1467
+bec_widgets/widgets/button_resume/register_resume_button.py,sha256=01t5Ruz7FkKt7vHUVHvRNgEKqRLbKDza3ZQxd4w0i8A,479
+bec_widgets/widgets/button_resume/resume_button.pyproject,sha256=QEPSupXQtXZDfT1Y0PuCv7Fj6NhBTq1dyvRiFNkvhH8,31
+bec_widgets/widgets/button_resume/resume_button_plugin.py,sha256=sqGn2I5XlsEpCjqZQBX8KNYpONJVAkBbzfFZL8OAsxI,1300
 bec_widgets/widgets/color_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/color_button/color_button.py,sha256=qGyZgQSFfF-IuZeEhdZv8t7hSx3YDFs22evmZejKC0Y,1229
 bec_widgets/widgets/color_button/color_button.pyproject,sha256=LUYF4VkDOB4ttVe7YfvLh64K-XZg0-xaVT06BqCT3UA,30
@@ -160,7 +174,7 @@ bec_widgets/widgets/position_indicator/position_indicator.pyproject,sha256=s0JEf
 bec_widgets/widgets/position_indicator/position_indicator_plugin.py,sha256=ehQPpwkjJ7k365i4gdwtmAmCbVmB1tvQLEo60J_ivo4,1413
 bec_widgets/widgets/position_indicator/register_position_indicator.py,sha256=OZNiMgM_80TPSAXK_0hXAkne4vUh8DGvh_OdpOiMpwI,516
 bec_widgets/widgets/positioner_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/widgets/positioner_box/positioner_box.py,sha256=BKRzfvWVjsjxb56g7FvjuMpY9Gks4DMe08sQuFAQDy4,11187
+bec_widgets/widgets/positioner_box/positioner_box.py,sha256=XJFbHiPkVbqp2wS6wgwzQUjqI_Iqu3CFmyQrDl0xFSY,11223
 bec_widgets/widgets/positioner_box/positioner_box.pyproject,sha256=7966pHdDseaHciaPNEKgdQgbUThSZf5wEDCeAEJh9po,32
 bec_widgets/widgets/positioner_box/positioner_box.ui,sha256=Y-Xp0z32okT7X4-rL5r7dF_QH_QpXvPes3f778cC7_k,5633
 bec_widgets/widgets/positioner_box/positioner_box_plugin.py,sha256=kJtQgRFGkJYWbZqJ7K7o0UhdsgAlODUVZL8pKJWwMhs,1413
@@ -178,7 +192,7 @@ bec_widgets/widgets/ring_progress_bar/ring_progress_bar.pyproject,sha256=ZNYDnKD
 bec_widgets/widgets/ring_progress_bar/ring_progress_bar_plugin.py,sha256=-rw9ZSThgAH0Ubbr3X-L5x-ZqMXUGnauyFb4OmfUvD4,1394
 bec_widgets/widgets/scan_control/__init__.py,sha256=IOfHl15vxb_uC6KN62-PeUzbBha_vQyqkkXbJ2HU674,38
 bec_widgets/widgets/scan_control/register_scan_control.py,sha256=xUX2yR0-MaIMg9_y9qe50yDDphzsh2x1b5PMrF90yPM,475
-bec_widgets/widgets/scan_control/scan_control.py,sha256=_GRqKd_hmLAJWaXwVUx4NXtGexyETLbRWki-3LJ9QkI,9458
+bec_widgets/widgets/scan_control/scan_control.py,sha256=pQkc9mPfGxOCJaJPuPUudSStuBk9lqUZovbGdY1cx7M,11587
 bec_widgets/widgets/scan_control/scan_control.pyproject,sha256=eTgVDFKToIH8_BbJjM2RvbOLr7HnYoidX0SAHx640DM,30
 bec_widgets/widgets/scan_control/scan_control_plugin.py,sha256=7GaqmaRgbwIPjVoXcyKVDl8UpfqC2weViup-YFfzUsM,1270
 bec_widgets/widgets/scan_control/scan_group_box.py,sha256=BpX9ZphqOhdEbQnGzNeNlmuZsMS__U97CkBMical2FY,9300
@@ -189,9 +203,9 @@ bec_widgets/widgets/spinner/spinner_widget.pyproject,sha256=zzLajGB3DTgVnrSqMey2
 bec_widgets/widgets/spinner/spinner_widget_plugin.py,sha256=AZYJJe40olMzqL6Edk6J-X_iNHcXrU-EQN4mCUCp_Fo,1355
 bec_widgets/widgets/stop_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/stop_button/register_stop_button.py,sha256=U7r3fEOH-uPhAQI-nTituHXDDXDWR4JQZ7_vD6b_dfM,471
-bec_widgets/widgets/stop_button/stop_button.py,sha256=GAssgEV_F6NJxmcdrQYfI2egVqYhQeMotdgnwLn9ISs,1517
+bec_widgets/widgets/stop_button/stop_button.py,sha256=TiCXLisaTdHKCcsNl5yMBUsYH9zUfwbeEe3zJrGH8qQ,1686
 bec_widgets/widgets/stop_button/stop_button.pyproject,sha256=Cc_xbv-zfzNVpsdg_1QyzuTlrJaM9_BkIjes70umrx0,29
-bec_widgets/widgets/stop_button/stop_button_plugin.py,sha256=Si1MSJo0izUxM4Bl_cPbihOCQWr9QUjTDpA7dKV8x5Y,1363
+bec_widgets/widgets/stop_button/stop_button_plugin.py,sha256=VT-WVLq89fw7PwML7JDMCF1bqfopLCZIgMA4yetl65M,1365
 bec_widgets/widgets/text_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/text_box/register_text_box.py,sha256=UwrmCoYjAAtJJK8BwC0P_wSb-lOlOvxPe3-Bemg_9nw,459
 bec_widgets/widgets/text_box/text_box.py,sha256=urkHtDQBSf4ws5BcpYIe5cfj-r-GXQOngcGUVYWvgRo,4297
@@ -224,8 +238,8 @@ bec_widgets/widgets/website/register_website_widget.py,sha256=LIQJpV9uqcBiPR9cEA
 bec_widgets/widgets/website/website.py,sha256=kDlqjwtx0yft1ZNRhTdHnYh_5KZHfqT_ZGPOKT4C-yI,2619
 bec_widgets/widgets/website/website_widget.pyproject,sha256=scOiV3cV1_BjbzpPzy2N8rIJL5P2qIZz8ObTJ-Uvdtg,25
 bec_widgets/widgets/website/website_widget_plugin.py,sha256=pz38_C2cZ0yvPPS02wdIPcmhFo_yiwUhflsASocAPQQ,1341
-bec_widgets-0.99.10.dist-info/METADATA,sha256=JQ0kq0C_gndkxeyqnay6w3QQyYb8ShQvxfkqEH3Rd4Q,1334
-bec_widgets-0.99.10.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.99.10.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.99.10.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.99.10.dist-info/RECORD,,
+bec_widgets-0.99.12.dist-info/METADATA,sha256=meqZoR4X-i0IEv8GXcSeCQBGzHpF6CdYR9oCul-5syA,1334
+bec_widgets-0.99.12.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.99.12.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.99.12.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.99.12.dist-info/RECORD,,

pyproject.toml

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