v_sim.UiPanelClass

Fields

None

Methods

class

getAllPanels ()

class

getAllWindows ()

class

getCommandPanel ()

class

getDockById (id)

class

getHeaderVisibility ()

class

getPanelById (id)

class

setCurrent (dataObj, view)

class

setHeaderVisibility (status)

Details

class v_sim.UiPanelClass

Opaque structure.

classmethod getAllPanels()
Returns:

a newly created list (use g_list_free() on it after use).

Return type:

[v_sim.UiPanel]

This routine can be used to know all existing v_sim.UiPanel.

classmethod getAllWindows()
Returns:

a newly created list (use g_list_free() on it after use).

Return type:

[v_sim.UiDockWindow]

This routine can be used to know all existing v_sim.UiDockWindow.

classmethod getCommandPanel()
Returns:

the v_sim.UiDockWindow that is inside the command panel.

Return type:

v_sim.UiDockWindow

There is always a v_sim.UiDockWindow that is inside the command panel. This routine gets it.

classmethod getDockById(id)
Parameters:

id (str) – a v_sim.UiDockWindow identifier.

Returns:

the v_sim.UiDockWindow that corresponds to this identifier. The dock window is built if not currently exist.

Return type:

v_sim.UiDockWindow

This routine associates a v_sim.UiDockWindow identifier to the object pointer.

classmethod getHeaderVisibility()
Returns:

True if the header uses text and label.

Return type:

bool

The header can be represented using the full image and label always or only the image when the tab is not on top.

New in version 3.8.

classmethod getPanelById(id)
Parameters:

id (str) – a v_sim.UiPanel identifier.

Returns:

the v_sim.UiPanel that corresponds to this identifier or None if none exists.

Return type:

v_sim.UiPanel

This routine associates a v_sim.UiPanel identifier to the object pointer.

classmethod setCurrent(dataObj, view)
Parameters:

Set the currently focussed v_sim.Data. It then can be retrieve using v_sim.UiPanel.getData().

New in version 3.7.

classmethod setHeaderVisibility(status)
Parameters:

status (bool) – a boolean.

The header can be represented using the full image and label always or only the image when the tab is not on top.