Karana.WebUI.easydock

Karana.WebUI.easydock#

Provides the EasyDock class.

Classes#

EasyDock

Class to simplify setup of a GUI consisting of IFrames.

Module Contents#

class Karana.WebUI.easydock.EasyDock(port: int = 0)[source]#

Class to simplify setup of a GUI consisting of IFrames.

server#
router#
dock#
iframes = []#
property port: int#

The server’s port.

Returns:

The port

Return type:

int

property url: str#

The server’s base url.

Returns:

The base url

Return type:

str

addFrame(url: str, title: str = 'untitled', *, relative_to: Any | None = None, direction: Literal['left', 'right', 'above', 'below', 'within'] | None = None) → Any[source]#

Add an IFrame panel to the dock.

Parameters:

  • url (str) – The url to open in the iframe

  • title (str) – Title of the panel containing the iframe

  • relative_to (Any | None) – Object returned from a previous call, specifying a frame to position relative to.

  • direction (Literal["left", "right", "above", "below", "within"] | None) – If relative_to was given, how to position the new frame

Returns:

An object to be used for relative_to

Return type:

Any

Contents