traitsui.dockable_view_element module

Defines the DockableViewElement class, which allows Traits UIs and Traits UI elements to be docked in external Pyface DockWindow windows.

class traitsui.dockable_view_element.DockableViewElement[source]

Bases: traits.has_traits.HasPrivateTraits, pyface.dock.idockable.IDockable

Allows Traits UIs and Traits UI elements to be docked in external Pyface DockWindow windows.

close_dock_control(dock_control, abort)[source]

Handles the closing of a DockControl containing a Traits UI.

dockable_get_control(parent)[source]

Gets a control that can be docked into a DockWindow.

dockable_init_dockcontrol(dock_control)[source]

Allows the object to override the default DockControl settings.

dockable_should_close()[source]

Should the current DockControl be closed before creating the new one?

element = Instance(ViewSubElement)

The (optional) element of the Traits UI that can be docked

should_close = Bool(False)

Should the DockControl be closed on redocking?

ui = Instance(UI)

The Traits UI that can be docked with an external DockWindow