pyface.tasks.i_dock_pane module

class pyface.tasks.i_dock_pane.IDockPane(adaptee, default=<class 'traits.adaptation.adaptation_error.AdaptationError'>)[source]

Bases: pyface.tasks.i_task_pane.ITaskPane

A pane that is useful but unessential for a task.

Dock panes are arranged around the central pane in dock areas, and can, in general, be moved, resized, and hidden by the user.

closable = Bool(True)

If enabled, the pane will have a button to close it, and a visibility toggle button will be added to the View menu. Otherwise, the pane’s visibility will only be adjustable programmatically, though the ‘visible’ attribute.

dock_area = Enum("left", "right", "top", "bottom")

The dock area in which the pane is currently present.

floatable = Bool(True)

Whether the pane can be detached from the main window.

floating = Bool(False)

Whether the pane is currently detached from the main window.

movable = Bool(True)

Whether the pane can be moved from one dock area to another.

size = Tuple()

The size of the dock pane. Note that this value is read-only.

visible = Bool(False)

Whether the pane is currently visible.

create_contents(parent)[source]

Create and return the toolkit-specific contents of the dock pane.

hide()[source]

Convenience method to hide the dock pane.

show()[source]

Convenience method to show the dock pane.

class pyface.tasks.i_dock_pane.MDockPane[source]

Bases: traits.has_traits.HasTraits

Mixin containing common code for toolkit-specific implementations.

hide()[source]

Convenience method to hide the dock pane.

show()[source]

Convenience method to show the dock pane.