bec-widgets 0.99.11__tar.gz → 0.99.13__tar.gz

{bec_widgets-0.99.11 → bec_widgets-0.99.13}/CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## v0.99.13 (2024-08-30)
+
+### Documentation
+
+* docs: minor updates to the widget tutorial ([`ec9c8f2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ec9c8f29633364c45ebd998a5411d428c1ce488d))
+
+* docs(widget tutorial): step by step guide added ([`b32ced8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b32ced85fff628a9e1303a781630cdae3865238e))
+
+### Fix
+
+* fix(dark mode button): fixed dark mode button state for external updates, including auto ([`a3110d9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a3110d98147295dcb1f9353f9aaf5461cba9232a))
+
+## 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
@@ -137,23 +159,3 @@ If not theme is set, the init of the BECWidget base class sets the default theme
 ### Test
 
 * test(dark_mode_button): added tests for dark mode button ([`df35aab`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df35aabff30c5d00b1c441132bd370446653741e))
-
-## v0.98.0 (2024-08-25)
-
-### Fix
-
-* fix(toolbar): removed hardcoded color values ([`afdf4e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/afdf4e8782a22566932180224fa1c924d24c810f))
-
-* fix: transitioning to material icons ([`2a82032`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2a82032644a84e38df04e2035a6aa63f4a046360))
-
-* fix(dock_area): transitioned to MaterialIconAction ([`88a2f66`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/88a2f667588e9aeb34ae556fa327898824052bc3))
-
-* 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))
-
-### Refactor
-
-* refactor(waveform): use set theme for demo ([`44cfda1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/44cfda1c07306669c9a4e09706d95e6b91dee370))

{bec_widgets-0.99.11 → bec_widgets-0.99.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.99.11
+Version: 0.99.13
 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.11 → bec_widgets-0.99.13}/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,7 @@ class Widgets(str, enum.Enum):
     DeviceLineEdit = "DeviceLineEdit"
     PositionerBox = "PositionerBox"
     PositionerControlLine = "PositionerControlLine"
+    ResetButton = "ResetButton"
     ResumeButton = "ResumeButton"
     RingProgressBar = "RingProgressBar"
     ScanControl = "ScanControl"
@@ -36,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):
@@ -2374,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
 
@@ -2385,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
 
@@ -2394,6 +2414,24 @@ 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

{bec_widgets-0.99.11 → bec_widgets-0.99.13}/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-0.99.11 → bec_widgets-0.99.13}/bec_widgets/utils/colors.py

@@ -8,7 +8,7 @@ import pyqtgraph as pg
 from bec_qthemes._os_appearance.listener import OSThemeSwitchListener
 from pydantic_core import PydanticCustomError
 from qtpy.QtGui import QColor
-from qtpy.QtWidgets import QApplication
+from qtpy.QtWidgets import QApplication, QPushButton, QToolButton
 
 
 def get_theme_palette():
@@ -56,6 +56,17 @@ def apply_theme(theme: Literal["dark", "light"]):
     for pg_widget in children:
         pg_widget.setBackground("k" if theme == "dark" else "w")
 
+    dark_mode_buttons = [
+        button
+        for button in app.topLevelWidgets()
+        if hasattr(button, "dark_mode_enabled")
+        and hasattr(button, "mode_button")
+        and isinstance(button.mode_button, (QPushButton, QToolButton))
+    ]
+
+    for button in dark_mode_buttons:
+        button.dark_mode_enabled = theme == "dark"
+        button.update_mode_button()
     # now define stylesheet according to theme and apply it
     style = bec_qthemes.load_stylesheet(theme)
     app.setStyleSheet(style)

bec_widgets-0.99.13/bec_widgets/widgets/button_abort/abort_button.pyproject

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

bec_widgets-0.99.13/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-0.99.13/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-0.99.13/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-0.99.13/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-0.99.13/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-0.99.13/bec_widgets/widgets/button_reset/reset_button.pyproject

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

bec_widgets-0.99.13/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-0.99.11 → bec_widgets-0.99.13}/bec_widgets/widgets/button_resume/button_resume.py

@@ -30,7 +30,7 @@ class ResumeButton(BECWidget, QWidget):
             self.button = QPushButton()
             self.button.setText("Resume")
             self.button.setStyleSheet(
-                "background-color:  #2793e8 color: white; font-weight: bold; font-size: 12px;"
+                "background-color:  #2793e8; color: white; font-weight: bold; font-size: 12px;"
             )
             self.button.clicked.connect(self.continue_scan)
 

{bec_widgets-0.99.11 → bec_widgets-0.99.13}/bec_widgets/widgets/dark_mode_button/dark_mode_button.py

@@ -1,6 +1,6 @@
 from bec_qthemes import material_icon
 from qtpy.QtCore import Property, Qt, Slot
-from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+from qtpy.QtWidgets import QApplication, QHBoxLayout, QPushButton, QToolButton, QWidget
 
 from bec_widgets.utils.bec_widget import BECWidget
 from bec_widgets.utils.colors import set_theme
@@ -27,17 +27,31 @@ class DarkModeButton(BECWidget, QWidget):
         self.layout.setContentsMargins(0, 0, 0, 0)
         self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
 
-        icon = material_icon("dark_mode", size=(20, 20), convert_to_pixmap=False)
         if toolbar:
-            self.mode_button = QToolButton(icon=icon)
+            self.mode_button = QToolButton()
         else:
-            self.mode_button = QPushButton(icon=icon)
+            self.mode_button = QPushButton()
+
+        self.dark_mode_enabled = self._get_qapp_dark_mode_state()
         self.update_mode_button()
         self.mode_button.clicked.connect(self.toggle_dark_mode)
         self.layout.addWidget(self.mode_button)
         self.setLayout(self.layout)
         self.setFixedSize(40, 40)
 
+    def _get_qapp_dark_mode_state(self) -> bool:
+        """
+        Get the dark mode state from the QApplication.
+
+        Returns:
+            bool: True if dark mode is enabled, False otherwise.
+        """
+        qapp = QApplication.instance()
+        if hasattr(qapp, "theme") and qapp.theme["theme"] == "dark":
+            return True
+
+        return False
+
     @Property(bool)
     def dark_mode_enabled(self) -> bool:
         """
@@ -72,8 +86,10 @@ class DarkModeButton(BECWidget, QWidget):
 if __name__ == "__main__":
     from qtpy.QtWidgets import QApplication
 
-    app = QApplication([])
+    from bec_widgets.utils.colors import set_theme
 
+    app = QApplication([])
+    set_theme("auto")
     w = DarkModeButton()
     w.show()
 

{bec_widgets-0.99.11 → bec_widgets-0.99.13}/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-0.99.11 → bec_widgets-0.99.13}/bec_widgets/widgets/stop_button/stop_button.py

@@ -37,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-0.99.11 → bec_widgets-0.99.13}/pyproject.toml

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