v_sim.UiPlaneList¶

Subclasses:: None

Methods¶

Inherited:: Gtk.ListStore (18), GObject.Object (37), Gtk.Buildable (10), Gtk.TreeDragDest (2), Gtk.TreeDragSource (3), Gtk.TreeModel (28), Gtk.TreeSortable (6)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`getAt` (i)
	`getControls` ()
	`getModel` ()
	`getSelection` ()
	`getView` ()
	`setModel` (set)

Virtual Methods¶

Inherited:: GObject.Object (7), Gtk.Buildable (10), Gtk.TreeDragDest (2), Gtk.TreeDragSource (3), Gtk.TreeModel (19), Gtk.TreeSortable (6)

Properties¶

Name	Type	Flags	Short Description
`selection`	`v_sim.Plane`	r/w	current selection

Signals¶

Inherited:: GObject.Object (1), Gtk.TreeModel (5), Gtk.TreeSortable (1)

Name	Short Description
`align`	This signal is emitted each time the user request to align with a plane.

Fields¶

Inherited:: GObject.Object (1), Gtk.TreeModel (5), Gtk.TreeSortable (1)

Name	Type	Access	Description
parent	`Gtk.ListStore`	r
priv	`v_sim.UiPlaneListPrivate`	r

Class Details¶

class v_sim.UiPlaneList(*column_types)¶

Bases:: Gtk.ListStore
Abstract:: No
Structure:: v_sim.UiPlaneListClass

Common name to refer to a #_VisuUiPlaneList.

classmethod new()¶

Returns:: a newly created object.
Return type:: v_sim.UiPlaneList

Create a new Gtk.ListStore to store planes.

New in version 3.8.

getAt(i)¶

Parameters:: i (int) – an integer.
Returns:: a v_sim.Plane object or None.
Return type:: v_sim.Plane

Retrieve the v_sim.Plane object, stored at the place i in self.

New in version 3.8.

getControls()¶

Returns:: widgets are created if needed.
Return type:: Gtk.Box

Retrieve the Gtk.Box object with the Gtk.Widget to control the selected plane in the treeview of self.

New in version 3.8.

getModel()¶

Returns:: a v_sim.PlaneSet object.
Return type:: v_sim.PlaneSet

Retrieve the v_sim.PlaneSet object that self is built upon.

New in version 3.8.

getSelection()¶

Returns:: a v_sim.Plane object or None.
Return type:: v_sim.Plane

Retrieve the selected v_sim.Plane, or None if no selection.

New in version 3.8.

getView()¶

Returns:: widgets are created if needed.
Return type:: Gtk.Widget

Retrieve a treeview and a side toolbar that displays the list of planes of the model.

New in version 3.8.

setModel(set)¶

Parameters:: set (v_sim.PlaneSet or None) – a v_sim.PlaneSet object.
Returns:: True if set is changed
Return type:: bool

Bind the set object to self.

Signal Details¶

v_sim.UiPlaneList.signals.align(ui_plane_list, plane)¶

Signal Name:

align

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

ui_plane_list (v_sim.UiPlaneList) – The object which received the signal
plane (v_sim.Plane) – the requested v_sim.Plane object for alignment.

This signal is emitted each time the user request to align with a plane.

New in version 3.8.

Property Details¶

v_sim.UiPlaneList.props.selection¶

Name:: selection
Type:: v_sim.Plane
Default Value:: None
Flags:: READABLE, WRITABLE

current selection