DockPane

class enaml.widgets.dock_pane.DockPane(parent=None, **kwargs)

Bases: enaml.widgets.widget.Widget

A widget which can be docked in a MainWindow.

A DockPane is a widget which can be docked in designated dock areas in a MainWindow. It can have at most a single child widget which is an instance of Container.

title = None

The title to use in the title bar.

title_bar_visible = None

Whether or not the title bar is visible.

title_bar_orientation = None

The orientation of the title bar.

closable = None

Whether or not the dock pane is closable via a close button.

movable = None

Whether or not the dock pane is movable by the user.

floatable = None

Whether or not the dock can be floated as a separate window.

floating = None

A boolean indicating whether or not the dock pane is floating.

dock_area = None

The dock area in the MainWindow where the pane is docked.

allowed_dock_areas = None

The dock areas in the MainWindow where the pane can be docked by the user. Note that this does not preclude the pane from being docked programmatically via the ‘dock_area’ attribute.

dock_widget = None

A read only property which returns the pane’s dock widget.

closed = None

An event fired when the user closes the pane by clicking on the dock pane’s close button.

snapshot()

Returns the snapshot dict for the DockPane.

on_action_closed(content)

Handle the ‘closed’ action from the client widget.

on_action_floated(content)

Handle the ‘floated’ action from the client widget.

on_action_docked(content)

Handle the ‘docked’ action from the client widget.

open()

Open the dock pane in the MainWindow.

Calling this method will also set the pane visibility to True.

close()

Close the dock pane in the MainWindow.

Calling this method will set the pane visibility to False.

__implements__

alias of __NoInterface__

Backends

Qt

class enaml.qt.qt_dock_pane.QtDockPane(object_id, parent, session)

Bases: enaml.qt.qt_widget.QtWidget

A Qt implementation of an Enaml DockPane.

create_widget(parent, tree)

Create the underlying dock pane widget.

create(tree)

Create and initialize the dock pane control.

init_layout()

Handle the layout initialization for the dock pane.

dock_widget()

Find and return the dock widget child for this widget.

Returns:result (QWidget or None) – The dock widget defined for this widget, or None if one is not defined.

child_removed(child)

Handle the child removed event for a QtDockPane.

child_added(child)

Handle the child added event for a QtDockPane.

on_closed()

The signal handler for the ‘closed’ signal.

on_floated()

The signal handler for the ‘floated’ signal.

on_docked(area)

The signal handler for the ‘docked’ signal.

on_action_set_title(content)

Handle the ‘set_title’ action from the Enaml widget.

on_action_set_title_bar_visible(content)

Handle the ‘set_title_bar_visible’ action from the Enaml widget.

on_action_set_title_bar_orientation(content)

Handle the ‘set_title_bar_orientation’ action from the Enaml widget.

on_action_set_closable(content)

Handle the ‘set_closable’ action from the Enaml widget.

on_action_set_movable(content)

Handle the ‘set_movable’ action from the Enaml widget.

on_action_set_floatable(content)

Handle the ‘set_floatable’ action from the Enaml widget.

on_action_set_floating(content)

Handle the ‘set_floating’ action from the Enaml widget.

on_action_set_dock_area(content)

Handle the ‘set_dock_area’ action from the Enaml widget.

on_action_set_allowed_dock_areas(content)

Handle the ‘set_allowed_dock_areas’ action from the Enaml widget.

on_action_open(content)

Handle the ‘open’ action from the Enaml widget.

on_action_close(content)

Handle the ‘close’ action from the Enaml widget.

set_title(title)

Set the title on the underlying widget.

set_title_bar_visible(visible)

Set the title bar visibility of the underlying widget.

set_title_bar_orientation(orientation)

Set the title bar orientation of the underyling widget.

set_closable(closable)

Set the closable state on the underlying widget.

set_movable(movable)

Set the movable state on the underlying widget.

set_floatable(floatable)

Set the floatable state on the underlying widget.

set_floating(floating)

Set the floating staet on the underlying widget.

set_dock_area(dock_area)

Set the dock area on the underlying widget.

set_allowed_dock_areas(dock_areas)

Set the allowed dock areas on the underlying widget.

Wx

class enaml.wx.wx_dock_pane.WxDockPane(object_id, parent, session)

Bases: enaml.wx.wx_widget.WxWidget

A Wx implementation of an Enaml DockPane.

create_widget(parent, tree)

Create the underlying wxDockPane widget.

create(tree)

Create and initialize the dock pane control.

init_layout()

Handle the layout initialization for the dock pane.

dock_widget()

Find and return the dock widget child for this widget.

Returns:result (wxWindow or None) – The dock widget defined for this widget, or None if one is not defined.

child_removed(child)

Handle the child removed event for a WxDockPane.

child_added(child)

Handle the child added event for a WxDockPane.

on_dock_pane_closed(event)

The event handler for the EVT_DOCK_PANE_CLOSED event.

on_dock_pane_floated(event)

The event handler for the EVT_DOCK_PANE_FLOATED event.

on_dock_pane_docked(event)

The event handler for the EVT_DOCK_PANE_AREA event.

on_action_set_title(content)

Handle the ‘set_title’ action from the Enaml widget.

on_action_set_title_bar_visible(content)

Handle the ‘set_title_bar_visible’ action from the Enaml widget.

on_action_set_title_bar_orientation(content)

Handle the ‘set_title_bar_orientation’ action from the Enaml widget.

on_action_set_closable(content)

Handle the ‘set_closable’ action from the Enaml widget.

on_action_set_movable(content)

Handle the ‘set_movable’ action from the Enaml widget.

on_action_set_floatable(content)

Handle the ‘set_floatable’ action from the Enaml widget.

on_action_set_floating(content)

Handle the ‘set_floating’ action from the Enaml widget.

on_action_set_dock_area(content)

Handle the ‘set_dock_area’ action from the Enaml widget.

on_action_set_allowed_dock_areas(content)

Handle the ‘set_allowed_dock_areas’ action from the Enaml widget.

on_action_open(content)

Handle the ‘open’ action from the Enaml widget.

on_action_close(content)

Handle the ‘close’ action from the Enaml widget.

set_visible(visible)

An overridden visibility setter which to opens|closes the dock pane.

set_title(title)

Set the title on the underlying widget.

set_title_bar_visible(visible)

Set the title bar visibility of the underlying widget.

set_title_bar_orientation(orientation)

Set the title bar orientation of the underyling widget.

set_closable(closable)

Set the closable state on the underlying widget.

set_movable(movable)

Set the movable state on the underlying widget.

set_floatable(floatable)

Set the floatable state on the underlying widget.

set_floating(floating)

Set the floating staet on the underlying widget.

set_dock_area(dock_area)

Set the dock area on the underyling widget.

set_allowed_dock_areas(dock_areas)

Set the allowed dock areas on the underlying widget.