mirror of
https://github.com/bec-project/bec_widgets.git
synced 2026-03-08 01:37:52 +01:00
fix: RPC client docstring
This commit is contained in:
@@ -4787,23 +4787,185 @@ class PositionerGroup(RPCBase):
|
||||
"""
|
||||
|
||||
|
||||
class ProcedureControl(RPCBase):
|
||||
class ProcedurePanel(RPCBase):
|
||||
@rpc_call
|
||||
def remove(self):
|
||||
def new(
|
||||
self,
|
||||
widget: "QWidget | str",
|
||||
*,
|
||||
closable: "bool" = True,
|
||||
floatable: "bool" = True,
|
||||
movable: "bool" = True,
|
||||
start_floating: "bool" = False,
|
||||
floating_state: "Mapping[str, object] | None" = None,
|
||||
where: "Literal['left', 'right', 'top', 'bottom'] | None" = None,
|
||||
on_close: "Callable[[CDockWidget, QWidget], None] | None" = None,
|
||||
tab_with: "CDockWidget | QWidget | str | None" = None,
|
||||
relative_to: "CDockWidget | QWidget | str | None" = None,
|
||||
return_dock: "bool" = False,
|
||||
show_title_bar: "bool | None" = None,
|
||||
title_buttons: "Mapping[str, bool] | Sequence[str] | str | None" = None,
|
||||
show_settings_action: "bool | None" = False,
|
||||
promote_central: "bool" = False,
|
||||
dock_icon: "QIcon | None" = None,
|
||||
apply_widget_icon: "bool" = True,
|
||||
object_name: "str | None" = None,
|
||||
**widget_kwargs,
|
||||
) -> "QWidget | CDockWidget | BECWidget":
|
||||
"""
|
||||
Cleanup the BECConnector
|
||||
Create a new widget (or reuse an instance) and add it as a dock.
|
||||
|
||||
Args:
|
||||
widget(QWidget | str): Instance or registered widget type string.
|
||||
closable(bool): Whether the dock is closable.
|
||||
floatable(bool): Whether the dock is floatable.
|
||||
movable(bool): Whether the dock is movable.
|
||||
start_floating(bool): Whether to start the dock floating.
|
||||
floating_state(Mapping | None): Optional floating geometry metadata to apply when floating.
|
||||
where(Literal["left", "right", "top", "bottom"] | None): Dock placement hint relative to the dock area (ignored when
|
||||
``relative_to`` is provided without an explicit value).
|
||||
on_close(Callable[[CDockWidget, QWidget], None] | None): Optional custom close handler accepting (dock, widget).
|
||||
tab_with(CDockWidget | QWidget | str | None): Existing dock (or widget/name) to tab the new dock alongside.
|
||||
relative_to(CDockWidget | QWidget | str | None): Existing dock (or widget/name) used as the positional anchor.
|
||||
When supplied and ``where`` is ``None``, the new dock inherits the
|
||||
anchor's current dock area.
|
||||
return_dock(bool): When True, return the created dock instead of the widget.
|
||||
show_title_bar(bool | None): Explicitly show or hide the dock area's title bar.
|
||||
title_buttons(Mapping[str, bool] | Sequence[str] | str | None): Mapping or iterable describing which title bar buttons should
|
||||
remain visible. Provide a mapping of button names (``"float"``,
|
||||
``"close"``, ``"menu"``, ``"auto_hide"``, ``"minimize"``) to booleans,
|
||||
or a sequence of button names to hide.
|
||||
show_settings_action(bool | None): Control whether a dock settings/property action should
|
||||
be installed. Defaults to ``False`` for the basic dock area; subclasses
|
||||
such as `AdvancedDockArea` override the default to ``True``.
|
||||
promote_central(bool): When True, promote the created dock to be the dock manager's
|
||||
central widget (useful for editor stacks or other root content).
|
||||
dock_icon(QIcon | None): Optional icon applied to the dock via ``CDockWidget.setIcon``.
|
||||
Provide a `QIcon` (e.g. from ``material_icon``). When ``None`` (default),
|
||||
the widget's ``ICON_NAME`` attribute is used when available.
|
||||
apply_widget_icon(bool): When False, skip automatically resolving the icon from
|
||||
the widget's ``ICON_NAME`` (useful for callers who want no icon and do not pass one explicitly).
|
||||
object_name(str | None): Optional object name to assign to the created widget.
|
||||
**widget_kwargs: Additional keyword arguments passed to the widget constructor
|
||||
when creating by type name.
|
||||
|
||||
Returns:
|
||||
The widget instance by default, or the created `CDockWidget` when `return_dock` is True.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def attach(self):
|
||||
def dock_map(self) -> "dict[str, CDockWidget]":
|
||||
"""
|
||||
None
|
||||
Return the dock widgets map as dictionary with names as keys.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def detach(self):
|
||||
def dock_list(self) -> "list[CDockWidget]":
|
||||
"""
|
||||
Detach the widget from its parent dock widget (if widget is in the dock), making it a floating widget.
|
||||
Return the list of dock widgets.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def widget_map(self, bec_widgets_only: "bool" = True) -> "dict[str, QWidget]":
|
||||
"""
|
||||
Return a dictionary mapping widget names to their corresponding widgets.
|
||||
|
||||
Args:
|
||||
bec_widgets_only(bool): If True, only include widgets that are BECConnector instances.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def widget_list(self, bec_widgets_only: "bool" = True) -> "list[QWidget]":
|
||||
"""
|
||||
Return a list of widgets contained in the dock area.
|
||||
|
||||
Args:
|
||||
bec_widgets_only(bool): If True, only include widgets that are BECConnector instances.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def attach_all(self):
|
||||
"""
|
||||
Re-attach floating docks back into the dock manager.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def delete_all(self):
|
||||
"""
|
||||
Delete all docks and their associated widgets.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def delete(self, object_name: "str") -> "bool":
|
||||
"""
|
||||
Remove a widget from the dock area by its object name.
|
||||
|
||||
Args:
|
||||
object_name: The object name of the widget to remove.
|
||||
|
||||
Returns:
|
||||
bool: True if the widget was found and removed, False otherwise.
|
||||
|
||||
Raises:
|
||||
ValueError: If no widget with the given object name is found.
|
||||
|
||||
Example:
|
||||
>>> dock_area.delete("my_widget")
|
||||
True
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def set_layout_ratios(
|
||||
self,
|
||||
*,
|
||||
horizontal: "Sequence[float] | Mapping[int | str, float] | None" = None,
|
||||
vertical: "Sequence[float] | Mapping[int | str, float] | None" = None,
|
||||
splitter_overrides: "Mapping[int | str | Sequence[int], Sequence[float] | Mapping[int | str, float]] | None" = None,
|
||||
) -> "None":
|
||||
"""
|
||||
Adjust splitter ratios in the dock layout.
|
||||
|
||||
Args:
|
||||
horizontal: Weights applied to every horizontal splitter encountered.
|
||||
vertical: Weights applied to every vertical splitter encountered.
|
||||
splitter_overrides: Optional overrides targeting specific splitters identified
|
||||
by their index path (e.g. ``{0: [1, 2], (1, 0): [3, 5]}``). Paths are zero-based
|
||||
indices following the splitter hierarchy, starting from the root splitter.
|
||||
|
||||
Example:
|
||||
To build three columns with custom per-column ratios::
|
||||
|
||||
area.set_layout_ratios(
|
||||
horizontal=[1, 2, 1], # column widths
|
||||
splitter_overrides={
|
||||
0: [1, 2], # column 0 (two rows)
|
||||
1: [3, 2, 1], # column 1 (three rows)
|
||||
2: [1], # column 2 (single row)
|
||||
},
|
||||
)
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def describe_layout(self) -> "list[dict[str, Any]]":
|
||||
"""
|
||||
Return metadata describing splitter paths, orientations, and contained docks.
|
||||
|
||||
Useful for determining the keys to use in `set_layout_ratios(splitter_overrides=...)`.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def print_layout_structure(self) -> "None":
|
||||
"""
|
||||
Pretty-print the current splitter paths to stdout.
|
||||
"""
|
||||
|
||||
@rpc_call
|
||||
def set_central_dock(self, dock: "CDockWidget | QWidget | str") -> "None":
|
||||
"""
|
||||
Promote an existing dock to be the dock manager's central widget.
|
||||
|
||||
Args:
|
||||
dock(CDockWidget | QWidget | str): Dock reference to promote.
|
||||
"""
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user