feat(dock_area): plugin added

bec_widgets/widgets/dock/dock_area.py

@@ -119,35 +119,35 @@ class BECDockArea(BECWidget, QWidget):
     def _hook_toolbar(self):
         # Menu Plot
         self.toolbar.widgets["menu_plots"].widgets["waveform"].triggered.connect(
-            lambda: self.add_dock(widget="BECWaveformWidget")
+            lambda: self.add_dock(widget="BECWaveformWidget", prefix="waveform")
         )
         self.toolbar.widgets["menu_plots"].widgets["image"].triggered.connect(
-            lambda: self.add_dock(widget="BECImageWidget")
+            lambda: self.add_dock(widget="BECImageWidget", prefix="image")
         )
         self.toolbar.widgets["menu_plots"].widgets["motor_map"].triggered.connect(
-            lambda: self.add_dock(widget="BECMotorMapWidget")
+            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")
+            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")
+            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")
+            lambda: self.add_dock(widget="BECQueue", prefix="queue")
         )
         self.toolbar.widgets["menu_utils"].widgets["status"].triggered.connect(
-            lambda: self.add_dock(widget="BECStatusBox")
+            lambda: self.add_dock(widget="BECStatusBox", prefix="status")
         )
         self.toolbar.widgets["menu_utils"].widgets["vs_code"].triggered.connect(
-            lambda: self.add_dock(widget="VSCodeEditor")
+            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")
+            lambda: self.add_dock(widget="RingProgressBar", prefix="progress_bar")
         )
 
         # Icons

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()