dock Package

dock Package

Pyface ‘DockWindow’ support.

This package implements a Pyface ‘dockable’ window component that allows child windows to be reorganized within the DockWindow using drag and drop. The component also allows multiple sub-windows to occupy the same sub-region of the DockWindow, in which case each sub-window appears as a separate notebook-like tab within the region.

api Module

dock_sizer Module

dock_window Module

dock_window_feature Module

dock_window_shell Module

feature_bar Module

feature_tool Module

idock_ui_provider Module

Defines the IDockUIProvider interface which objects which support being dragged and dropped into a DockWindow must implement.

class pyface.dock.idock_ui_provider.IDockUIProvider

Bases: object

get_dockable_ui(parent)

Returns a Traits UI which a DockWindow can imbed.

idockable Module

Defines the IDockable interface which objects contained in a DockWindow DockControl can implement in order to allow themselves to be dragged into a different DockWindow.

class pyface.dock.idockable.IDockable

Bases: object

dockable_bind(dock_control)

Handles the dockable being bound to a specified DockControl.

dockable_close(dock_control, force)

Returns whether or not it is OK to close the control.

dockable_dclick(dock_control, event)

Handles the user double-clicking on the DockControl. A result of False indicates the event was not handled; all other results indicate that the event was handled successfully.

dockable_get_control(parent)

Gets a control that can be docked into a DockWindow.

dockable_init_dockcontrol(dock_control)

Allows the object to override the default DockControl settings.

dockable_menu(dock_control, event)

Returns the right-click popup menu for a DockControl (if any).

dockable_should_close()

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

dockable_tab_activated(dock_control, activated)

Handles a notebook tab being activated or deactivated.

‘dock_control’ is the control being activated or deactivated.

If ‘activated’ is True, the control is being activated; otherwise the control is being deactivated.

ifeature_tool Module

Defines the IFeatureTool interface which allows objects dragged using the DockWindowFeature API to control the drag target and drop events. Useful for implementing tools which can be dropped onto compatible view objects.

class pyface.dock.ifeature_tool.IFeatureTool

Bases: object

feature_can_drop_on(object)

Returns whether or not the object being dragged (i.e. self) can be dropped on the specified target object.

feature_can_drop_on_dock_control(dock_control)

Returns whether or not the object being dragged (i.e. self) can be dropped on the specified target object’s DockControl.

feature_dropped_on(object)

Allows the dragged object (i.e. self) to handle being dropped on the specified target object.

feature_dropped_on_dock_control(dock_control)

Allows the dragged object (i.e. self) to handle being dropped on the specified target object’s DockControl.