From 6fced7e80107f10380e98a123ffba4ef735c862d Mon Sep 17 00:00:00 2001 From: wyzula-jan Date: Fri, 12 Dec 2025 16:04:47 +0100 Subject: [PATCH] wip client regenrated --- bec_widgets/cli/client.py | 293 -------------------------------------- 1 file changed, 293 deletions(-) diff --git a/bec_widgets/cli/client.py b/bec_widgets/cli/client.py index 5b4955ed..c4fe4785 100644 --- a/bec_widgets/cli/client.py +++ b/bec_widgets/cli/client.py @@ -27,7 +27,6 @@ class _WidgetsEnumType(str, enum.Enum): _Widgets = { - "BECDockArea": "BECDockArea", "BECMainWindow": "BECMainWindow", "BECProgressBar": "BECProgressBar", "BECQueue": "BECQueue", @@ -283,298 +282,6 @@ class AvailableDeviceResources(RPCBase): """ -class BECDock(RPCBase): - @property - @rpc_call - def _config_dict(self) -> "dict": - """ - Get the configuration of the widget. - - Returns: - dict: The configuration of the widget. - """ - - @property - @rpc_call - def element_list(self) -> "list[BECWidget]": - """ - Get the widgets in the dock. - - Returns: - widgets(list): The widgets in the dock. - """ - - @property - @rpc_call - def elements(self) -> "dict[str, BECWidget]": - """ - Get the widgets in the dock. - - Returns: - widgets(dict): The widgets in the dock. - """ - - @rpc_call - def new( - self, - widget: "BECWidget | str", - name: "str | None" = None, - row: "int | None" = None, - col: "int" = 0, - rowspan: "int" = 1, - colspan: "int" = 1, - shift: "Literal['down', 'up', 'left', 'right']" = "down", - ) -> "BECWidget": - """ - Add a widget to the dock. - - Args: - widget(QWidget): The widget to add. It can not be BECDock or BECDockArea. - name(str): The name of the widget. - row(int): The row to add the widget to. If None, the widget will be added to the next available row. - col(int): The column to add the widget to. - rowspan(int): The number of rows the widget should span. - colspan(int): The number of columns the widget should span. - shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied. - """ - - @rpc_call - def show(self): - """ - Show the dock. - """ - - @rpc_call - def hide(self): - """ - Hide the dock. - """ - - @rpc_call - def show_title_bar(self): - """ - Hide the title bar of the dock. - """ - - @rpc_call - def set_title(self, title: "str"): - """ - Set the title of the dock. - - Args: - title(str): The title of the dock. - """ - - @rpc_call - def hide_title_bar(self): - """ - Hide the title bar of the dock. - """ - - @rpc_call - def available_widgets(self) -> "list": - """ - List all widgets that can be added to the dock. - - Returns: - list: The list of eligible widgets. - """ - - @rpc_call - def delete(self, widget_name: "str") -> "None": - """ - Remove a widget from the dock. - - Args: - widget_name(str): Delete the widget with the given name. - """ - - @rpc_call - def delete_all(self): - """ - Remove all widgets from the dock. - """ - - @rpc_call - def remove(self): - """ - Remove the dock from the parent dock area. - """ - - @rpc_call - def attach(self): - """ - Attach the dock to the parent dock area. - """ - - @rpc_call - def detach(self): - """ - Detach the dock from the parent dock area. - """ - - -class BECDockArea(RPCBase): - """Container for other widgets. Widgets can be added to the dock area and arranged in a grid layout.""" - - @property - @rpc_call - def _rpc_id(self) -> "str": - """ - Get the RPC ID of the widget. - """ - - @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. - """ - - @rpc_call - def new( - self, - name: "str | None" = None, - widget: "str | QWidget | None" = None, - widget_name: "str | None" = None, - position: "Literal['bottom', 'top', 'left', 'right', 'above', 'below']" = "bottom", - relative_to: "BECDock | None" = None, - closable: "bool" = True, - floating: "bool" = False, - row: "int | None" = None, - col: "int" = 0, - rowspan: "int" = 1, - colspan: "int" = 1, - ) -> "BECDock": - """ - Add a dock to the dock area. Dock has QGridLayout as layout manager by default. - - Args: - name(str): The name of the dock to be displayed and for further references. Has to be unique. - widget(str|QWidget|None): The widget to be added to the dock. While using RPC, only BEC RPC widgets from RPCWidgetHandler are allowed. - position(Literal["bottom", "top", "left", "right", "above", "below"]): The position of the dock. - relative_to(BECDock): The dock to which the new dock should be added relative to. - closable(bool): Whether the dock is closable. - floating(bool): Whether the dock is detached after creating. - row(int): The row of the added widget. - col(int): The column of the added widget. - rowspan(int): The rowspan of the added widget. - colspan(int): The colspan of the added widget. - - Returns: - BECDock: The created dock. - """ - - @rpc_call - def show(self): - """ - Show all windows including floating docks. - """ - - @rpc_call - def hide(self): - """ - Hide all windows including floating docks. - """ - - @property - @rpc_call - def panels(self) -> "dict[str, BECDock]": - """ - Get the docks in the dock area. - Returns: - dock_dict(dict): The docks in the dock area. - """ - - @property - @rpc_call - def panel_list(self) -> "list[BECDock]": - """ - Get the docks in the dock area. - - Returns: - list: The docks in the dock area. - """ - - @rpc_call - def delete(self, dock_name: "str"): - """ - Delete a dock by name. - - Args: - dock_name(str): The name of the dock to delete. - """ - - @rpc_call - def delete_all(self) -> "None": - """ - Delete all docks. - """ - - @rpc_call - def remove(self) -> "None": - """ - Remove the dock area. If the dock area is embedded in a BECMainWindow and - is set as the central widget, the main window will be closed. - """ - - @rpc_call - def detach_dock(self, dock_name: "str") -> "BECDock": - """ - Undock a dock from the dock area. - - Args: - dock_name(str): The dock to undock. - - Returns: - BECDock: The undocked dock. - """ - - @rpc_call - def attach_all(self): - """ - Return all floating docks to the dock area. - """ - - @rpc_call - def save_state(self) -> "dict": - """ - Save the state of the dock area. - - Returns: - dict: The state of the dock area. - """ - - @rpc_timeout(None) - @rpc_call - def screenshot(self, file_name: "str | None" = None): - """ - Take a screenshot of the dock area and save it to a file. - """ - - @rpc_call - def restore_state( - self, state: "dict" = None, missing: "Literal['ignore', 'error']" = "ignore", extra="bottom" - ): - """ - Restore the state of the dock area. If no state is provided, the last state is restored. - - Args: - state(dict): The state to restore. - missing(Literal['ignore','error']): What to do if a dock is missing. - extra(str): Extra docks that are in the dockarea but that are not mentioned in state will be added to the bottom of the dockarea, unless otherwise specified by the extra argument. - """ - - class BECMainWindow(RPCBase): @rpc_call def remove(self):