v_sim.UiDockWindow

Fields

None

Methods

	getCharacteristics (id, visibility, x, y, width, height)
	getContainer ()
	getNotebook ()
	getWindow ()
	setPosition (x, y)
	setSize (width, height)
	setVisibility (visible)

Details

class v_sim.UiDockWindow

Short name for the structure of containers of v_sim.UiPanel.

getCharacteristics(id, visibility, x, y, width, height)

Parameters:

• id (str) – a location to store the identifier (owned by V_Sim) ;

• visibility (bool) – a location to store the status of the dock, hidden or not ;

• x (int) – a location to store its x position on the root window ;

• y (int) – a location to store its y position on the root window ;

• width (int) – a location to store its width ;

• height (int) – a location to store its height.

A routine to know everything about a v_sim.UiDockWindow.

getContainer()

Returns:

a top-level container (usually a Gtk.VBox).

Return type:

Gtk.Widget

A dock window is a small utility window with a list of v_sim.UiPanel. This window can be embedded in a container or have its own Gtk.Window. This routine get the top-level container inside a given v_sim.UiDockWindow. If you prefer to get the Gtk.Window containing the v_sim.UiDockWindow use v_sim.UiDockWindow.getWindow() instead.

getNotebook()

Returns:

the Gtk.Notebook containing the v_sim.UiPanel of this v_sim.UiDockWindow.

Return type:

Gtk.Widget

A dock window is a small utility window with a list of v_sim.UiPanel. All v_sim.UiPanel are contained in a Gtk.Notebook. This routine gets it.

getWindow()

Returns:

a top-level container (usually a Gtk.Window) or None.

Return type:

Gtk.Widget

A dock window is a small utility window with a list of v_sim.UiPanel. This window can be embedded in a container or have its own Gtk.Window. This routine get the Gtk.Window containing the v_sim.UiDockWindow in the case the dock is stand-alone. If not None is returned.

setPosition(x, y)

Parameters:

• x (int) – the requested x position ;

• y (int) – the requested y position.

Change the position of the given v_sim.UiDockWindow. The position is possibly adapted to avoid been out of screen.

setSize(width, height)

Parameters:

• width (int) – the requested width ;

• height (int) – the requested height.

Change the size of the given v_sim.UiDockWindow. The size is possibly adapted to avoid been out of screen.

setVisibility(visible)

Parameters:

visible (bool) – a boolean.

Change the visibility of a v_sim.UiDockWindow. If hidden, the dock is added to the list of hidden v_sim.UiDockWindow that can be shown again using the pop-up menu on every visible v_sim.UiDockWindow. The ‘Main’ dock window can not be hidden.