bec-widgets 0.90.0__py3-none-any.whl → 0.92.0__py3-none-any.whl

bec_widgets/widgets/dock/dock_area.py

@@ -7,11 +7,18 @@ from pydantic import Field
 from pyqtgraph.dockarea.DockArea import DockArea
 from qtpy.QtCore import Qt
 from qtpy.QtGui import QPainter, QPaintEvent
-from qtpy.QtWidgets import QWidget
-
+from qtpy.QtWidgets import QVBoxLayout, QWidget
+
+from bec_widgets.qt_utils.toolbar import (
+    ExpandableMenuAction,
+    IconAction,
+    ModularToolBar,
+    SeparatorAction,
+)
 from bec_widgets.utils import ConnectionConfig, WidgetContainerUtils
 from bec_widgets.utils.bec_widget import BECWidget
 
+from ...qt_utils.error_popups import SafeSlot
 from .dock import BECDock, DockConfig
 
 
@@ -22,7 +29,7 @@ class DockAreaConfig(ConnectionConfig):
     )
 
 
-class BECDockArea(BECWidget, DockArea):
+class BECDockArea(BECWidget, QWidget):
     USER_ACCESS = [
         "_config_dict",
         "panels",
@@ -51,15 +58,112 @@ class BECDockArea(BECWidget, DockArea):
                 config = DockAreaConfig(**config)
             self.config = config
         super().__init__(client=client, config=config, gui_id=gui_id)
-        DockArea.__init__(self, parent=parent)
+        QWidget.__init__(self, parent=parent)
+        self.layout = QVBoxLayout(self)
+        self.layout.setSpacing(5)
+        self.layout.setContentsMargins(0, 0, 0, 0)
 
         self._instructions_visible = True
 
-    def paintEvent(self, event: QPaintEvent):
+        self.dock_area = DockArea()
+        self.toolbar = ModularToolBar(
+            actions={
+                "menu_plots": ExpandableMenuAction(
+                    label="Add Plot ",
+                    actions={
+                        "waveform": IconAction(icon_path="waveform.svg", tooltip="Add Waveform"),
+                        "image": IconAction(icon_path="image.svg", tooltip="Add Image"),
+                        "motor_map": IconAction(icon_path="motor_map.svg", tooltip="Add Motor Map"),
+                    },
+                ),
+                "separator_0": SeparatorAction(),
+                "menu_devices": ExpandableMenuAction(
+                    label="Add Device Control ",
+                    actions={
+                        "scan_control": IconAction(
+                            icon_path="scan_control.svg", tooltip="Add Scan Control"
+                        ),
+                        "device_box": IconAction(
+                            icon_path="device_box.svg", tooltip="Add Device Box"
+                        ),
+                    },
+                ),
+                "separator_1": SeparatorAction(),
+                "menu_utils": ExpandableMenuAction(
+                    label="Add Utils ",
+                    actions={
+                        "queue": IconAction(icon_path="queue.svg", tooltip="Add Scan Queue"),
+                        "vs_code": IconAction(icon_path="terminal.svg", tooltip="Add VS Code"),
+                        "status": IconAction(icon_path="status.svg", tooltip="Add BEC Status Box"),
+                        "progress_bar": IconAction(
+                            icon_path="ring_progress.svg", tooltip="Add Circular ProgressBar"
+                        ),
+                    },
+                ),
+                "separator_2": SeparatorAction(),
+                "attach_all": IconAction(
+                    icon_path="attach_all.svg", tooltip="Attach all floating docks"
+                ),
+                "save_state": IconAction(icon_path="save_state.svg", tooltip="Save Dock State"),
+                "restore_state": IconAction(
+                    icon_path="restore_state.svg", tooltip="Restore Dock State"
+                ),
+            },
+            target_widget=self,
+        )
+
+        self.layout.addWidget(self.toolbar)
+        self.layout.addWidget(self.dock_area)
+        self._hook_toolbar()
+
+    def _hook_toolbar(self):
+        # Menu Plot
+        self.toolbar.widgets["menu_plots"].widgets["waveform"].triggered.connect(
+            lambda: self.add_dock(widget="BECWaveformWidget", prefix="waveform")
+        )
+        self.toolbar.widgets["menu_plots"].widgets["image"].triggered.connect(
+            lambda: self.add_dock(widget="BECImageWidget", prefix="image")
+        )
+        self.toolbar.widgets["menu_plots"].widgets["motor_map"].triggered.connect(
+            lambda: self.add_dock(widget="BECMotorMapWidget", prefix="motor_map")
+        )
+
+        # Menu Devices
+        self.toolbar.widgets["menu_devices"].widgets["scan_control"].triggered.connect(
+            lambda: self.add_dock(widget="ScanControl", prefix="scan_control")
+        )
+        self.toolbar.widgets["menu_devices"].widgets["device_box"].triggered.connect(
+            lambda: self.add_dock(widget="DeviceBox", prefix="device_box")
+        )
+
+        # Menu Utils
+        self.toolbar.widgets["menu_utils"].widgets["queue"].triggered.connect(
+            lambda: self.add_dock(widget="BECQueue", prefix="queue")
+        )
+        self.toolbar.widgets["menu_utils"].widgets["status"].triggered.connect(
+            lambda: self.add_dock(widget="BECStatusBox", prefix="status")
+        )
+        self.toolbar.widgets["menu_utils"].widgets["vs_code"].triggered.connect(
+            lambda: self.add_dock(widget="VSCodeEditor", prefix="vs_code")
+        )
+        self.toolbar.widgets["menu_utils"].widgets["progress_bar"].triggered.connect(
+            lambda: self.add_dock(widget="RingProgressBar", prefix="progress_bar")
+        )
+
+        # Icons
+        self.toolbar.widgets["attach_all"].action.triggered.connect(self.attach_all)
+        self.toolbar.widgets["save_state"].action.triggered.connect(self.save_state)
+        self.toolbar.widgets["restore_state"].action.triggered.connect(self.restore_state)
+
+    def paintEvent(self, event: QPaintEvent):  # TODO decide if we want any default instructions
         super().paintEvent(event)
         if self._instructions_visible:
             painter = QPainter(self)
-            painter.drawText(self.rect(), Qt.AlignCenter, "Add docks using 'add_dock' method")
+            painter.drawText(
+                self.rect(),
+                Qt.AlignCenter,
+                "Add docks using 'add_dock' method from CLI\n or \n Add widget docks using the toolbar",
+            )
 
     @property
     def panels(self) -> dict[str, BECDock]:
@@ -68,11 +172,11 @@ class BECDockArea(BECWidget, DockArea):
         Returns:
             dock_dict(dict): The docks in the dock area.
         """
-        return dict(self.docks)
+        return dict(self.dock_area.docks)
 
     @panels.setter
     def panels(self, value: dict[str, BECDock]):
-        self.docks = WeakValueDictionary(value)
+        self.dock_area.docks = WeakValueDictionary(value)
 
     @property
     def temp_areas(self) -> list:
@@ -82,12 +186,13 @@ class BECDockArea(BECWidget, DockArea):
         Returns:
             list: The temporary areas in the dock area.
         """
-        return list(map(str, self.tempAreas))
+        return list(map(str, self.dock_area.tempAreas))
 
     @temp_areas.setter
     def temp_areas(self, value: list):
-        self.tempAreas = list(map(str, value))
+        self.dock_area.tempAreas = list(map(str, value))
 
+    @SafeSlot()
     def restore_state(
         self, state: dict = None, missing: Literal["ignore", "error"] = "ignore", extra="bottom"
     ):
@@ -101,8 +206,9 @@ class BECDockArea(BECWidget, DockArea):
         """
         if state is None:
             state = self.config.docks_state
-        self.restoreState(state, missing=missing, extra=extra)
+        self.dock_area.restoreState(state, missing=missing, extra=extra)
 
+    @SafeSlot()
     def save_state(self) -> dict:
         """
         Save the state of the dock area.
@@ -110,7 +216,7 @@ class BECDockArea(BECWidget, DockArea):
         Returns:
             dict: The state of the dock area.
         """
-        last_state = self.saveState()
+        last_state = self.dock_area.saveState()
         self.config.docks_state = last_state
         return last_state
 
@@ -121,23 +227,24 @@ class BECDockArea(BECWidget, DockArea):
         Args:
             name(str): The name of the dock to remove.
         """
-        dock = self.docks.pop(name, None)
+        dock = self.dock_area.docks.pop(name, None)
         self.config.docks.pop(name, None)
         if dock:
             dock.close()
-            if len(self.docks) <= 1:
-                for dock in self.docks.values():
+            if len(self.dock_area.docks) <= 1:
+                for dock in self.dock_area.docks.values():
                     dock.hide_title_bar()
 
         else:
             raise ValueError(f"Dock with name {name} does not exist.")
 
+    @SafeSlot(popup_error=True)
     def add_dock(
         self,
         name: str = None,
         position: Literal["bottom", "top", "left", "right", "above", "below"] = None,
         relative_to: BECDock | None = None,
-        closable: bool = False,
+        closable: bool = True,
         floating: bool = False,
         prefix: str = "dock",
         widget: str | QWidget | None = None,
@@ -167,10 +274,10 @@ class BECDockArea(BECWidget, DockArea):
         """
         if name is None:
             name = WidgetContainerUtils.generate_unique_widget_id(
-                container=self.docks, prefix=prefix
+                container=self.dock_area.docks, prefix=prefix
             )
 
-        if name in set(self.docks.keys()):
+        if name in set(self.dock_area.docks.keys()):
             raise ValueError(f"Dock with name {name} already exists.")
 
         if position is None:
@@ -180,19 +287,21 @@ class BECDockArea(BECWidget, DockArea):
         dock.config.position = position
         self.config.docks[name] = dock.config
 
-        self.addDock(dock=dock, position=position, relativeTo=relative_to)
+        self.dock_area.addDock(dock=dock, position=position, relativeTo=relative_to)
 
-        if len(self.docks) <= 1:
+        if len(self.dock_area.docks) <= 1:
             dock.hide_title_bar()
-        elif len(self.docks) > 1:
-            for dock in self.docks.values():
+        elif len(self.dock_area.docks) > 1:
+            for dock in self.dock_area.docks.values():
                 dock.show_title_bar()
 
         if widget is not None and isinstance(widget, str):
             dock.add_widget(widget=widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
         elif widget is not None and isinstance(widget, QWidget):
             dock.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        if self._instructions_visible:
+        if (
+            self._instructions_visible
+        ):  # TODO still decide how initial instructions should be handled
             self._instructions_visible = False
             self.update()
         if floating:
@@ -209,26 +318,27 @@ class BECDockArea(BECWidget, DockArea):
         Returns:
             BECDock: The undocked dock.
         """
-        dock = self.docks[dock_name]
+        dock = self.dock_area.docks[dock_name]
         dock.detach()
         return dock
 
+    @SafeSlot()
     def attach_all(self):
         """
         Return all floating docks to the dock area.
         """
-        while self.tempAreas:
-            for temp_area in self.tempAreas:
-                self.removeTempArea(temp_area)
+        while self.dock_area.tempAreas:
+            for temp_area in self.dock_area.tempAreas:
+                self.dock_area.removeTempArea(temp_area)
 
     def clear_all(self):
         """
         Close all docks and remove all temp areas.
         """
         self.attach_all()
-        for dock in dict(self.docks).values():
+        for dock in dict(self.dock_area.docks).values():
             dock.remove()
-        self.docks.clear()
+        self.dock_area.docks.clear()
 
     def cleanup(self):
         """

bec_widgets/widgets/dock/dock_area.pyproject

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

bec_widgets/widgets/dock/dock_area_plugin.py

@@ -0,0 +1,59 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+import bec_widgets
+from bec_widgets.widgets.dock import BECDockArea
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='BECDockArea' name='dock_area'>
+    </widget>
+</ui>
+"""
+
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
+
+class BECDockAreaPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = BECDockArea(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Plots"
+
+    def icon(self):
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "dock_area.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "dock_area"
+
+    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 "BECDockArea"
+
+    def toolTip(self):
+        return "BECDockArea"
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/dock/register_dock_area.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.dock.dock_area_plugin import BECDockAreaPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(BECDockAreaPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/position_indicator/position_indicator_plugin.py

@@ -1,9 +1,11 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 from qtpy.QtGui import QIcon
 
+import bec_widgets
 from bec_widgets.widgets.position_indicator.position_indicator import PositionIndicator
 
 DOM_XML = """
@@ -13,6 +15,8 @@ DOM_XML = """
 </ui>
 """
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 class PositionIndicatorPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
@@ -27,10 +31,11 @@ class PositionIndicatorPlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return DOM_XML
 
     def group(self):
-        return ""
+        return "BEC Utils"
 
     def icon(self):
-        return QIcon()
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "position_indicator.png")
+        return QIcon(icon_path)
 
     def includeFile(self):
         return "position_indicator"

bec_widgets/widgets/ring_progress_bar/register_ring_progress_bar.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.ring_progress_bar.ring_progress_bar_plugin import RingProgressBarPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(RingProgressBarPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/ring_progress_bar/ring_progress_bar.pyproject

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

bec_widgets/widgets/ring_progress_bar/ring_progress_bar_plugin.py

@@ -0,0 +1,58 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+import bec_widgets
+from bec_widgets.widgets.ring_progress_bar.ring_progress_bar import RingProgressBar
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='RingProgressBar' name='ring_progress_bar'>
+    </widget>
+</ui>
+"""
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
+
+class RingProgressBarPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = RingProgressBar(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Utils"
+
+    def icon(self):
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "ring_progress.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "ring_progress_bar"
+
+    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 "RingProgressBar"
+
+    def toolTip(self):
+        return "RingProgressBar"
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/scan_control/register_scan_control.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.scan_control.scan_control_plugin import ScanControlPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ScanControlPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/scan_control/scan_control.pyproject

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

bec_widgets/widgets/scan_control/scan_control_plugin.py

@@ -0,0 +1,58 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+import bec_widgets
+from bec_widgets.widgets.scan_control.scan_control import ScanControl
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ScanControl' name='scan_control'>
+    </widget>
+</ui>
+"""
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
+
+class ScanControlPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ScanControl(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "Device Control"
+
+    def icon(self):
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "scan_control.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "scan_control"
+
+    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 "ScanControl"
+
+    def toolTip(self):
+        return "ScanControl"
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/spinner/spinner_widget_plugin.py

@@ -1,9 +1,11 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 from qtpy.QtGui import QIcon
 
+import bec_widgets
 from bec_widgets.widgets.spinner.spinner import SpinnerWidget
 
 DOM_XML = """
@@ -13,6 +15,8 @@ DOM_XML = """
 </ui>
 """
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 class SpinnerWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
@@ -27,10 +31,11 @@ class SpinnerWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return ""
+        return "BEC Utils"
 
     def icon(self):
-        return QIcon()
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "spinner.png")
+        return QIcon(icon_path)
 
     def includeFile(self):
         return "spinner_widget"

bec_widgets/widgets/stop_button/stop_button_plugin.py

@@ -5,6 +5,7 @@ import os
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 from qtpy.QtGui import QIcon
 
+import bec_widgets
 from bec_widgets.widgets.stop_button.stop_button import StopButton
 
 DOM_XML = """
@@ -14,6 +15,8 @@ DOM_XML = """
 </ui>
 """
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 class StopButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
@@ -28,11 +31,10 @@ class StopButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return "BEC Buttons"
+        return "BEC Utils"
 
     def icon(self):
-        current_path = os.path.dirname(__file__)
-        icon_path = os.path.join(current_path, "assets", "stop.png")
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "stop.png")
         return QIcon(icon_path)
 
     def includeFile(self):

bec_widgets/widgets/text_box/register_text_box.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.text_box.text_box_plugin import TextBoxPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(TextBoxPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/text_box/text_box.pyproject

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