Draft: Feat/dock area

Description

BECDockArea is a widget that encompasses BECDock elements capable of hosting any type of QWidget. The primary objective is to replace the current BECFigure in the BECIPythonClient with BECDockArea. This substitution aims to retain all existing functionalities of BECFigure while introducing dockable capabilities.

Related Issues

close #136 (closed)

Type of Change

• new BECDockArea
• new BECDock
• Refactor → WidgetConfig of BECFigure subplots is renamed to SubplotConfig for clarity.

Potential side effects

Not known, has to be tested with the running BECIPythonClient.

Screenshots / GIFs (if applicable)

[Include any relevant screenshots or GIFs to showcase the changes made.]

Additional Comments

[Add any additional comments or information that may be helpful for reviewers.]

Definition of Done

• Documentation is up-to-date.
• rpc access
• unit tests
• e2e tests

bec_widgets/cli/client.py

@@ -248,11 +248,11 @@ class BECWaveform(RPCBase):
         """
 
     @rpc_call
-    def apply_config(self, config: "dict | WidgetConfig", replot_last_scan: "bool" = False):
+    def apply_config(self, config: "dict | SubplotConfig", replot_last_scan: "bool" = False):
         """
         Apply the configuration to the 1D waveform widget.
         Args:
-            config(dict|WidgetConfig): Configuration settings.
+            config(dict|SubplotConfig): Configuration settings.
             replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
         """
 
@@ -614,6 +614,13 @@ class BECFigure(RPCBase, BECFigureClientMixin):
         Clear all widgets from the figure and reset to default state
         """
 
+    @property
+    @rpc_call
+    def containers(self) -> "dict":
+        """
+        None
+        """
+
 
 class BECCurve(RPCBase):
     @property