Window

class enaml.widgets.window.Window(parent=None, **kwargs)

Bases: enaml.widgets.widget.Widget

A top-level Window component.

A Window component is represents of a top-level visible component with a frame decoration. It may have at most one child widget which is dubbed the ‘central widget’. The central widget is an instance of Container and is expanded to fit the size of the window.

A Window does not support features like MenuBars or DockPanes, for such functionality, use a MainWindow widget.

title = None

The titlebar text.

initial_size = None

The initial size of the window. A value of (-1, -1) indicates to let the client choose the initial size

modality = None

An enum which indicates the modality of the window. The default value is ‘non_modal’.

closed = None

An event fired when the window is closed.

central_widget = None

Returns the central widget in use for the Window

icon_source = None

The source url for the titlebar icon.

snapshot()

Return the snapshot for a Window.

bind()

A method called after initialization which allows the widget to bind any event handlers necessary.

on_action_closed(content)

Handle the ‘closed’ action from the client widget.

close()

Send the ‘close’ action to the client widget.

maximize()

Send the ‘maximize’ action to the client widget.

minimize()

Send the ‘minimize’ action to the client widget.

restore()

Send the ‘restore’ action to the client widget.

__implements__

alias of __NoInterface__

Backends

Qt

class enaml.qt.qt_window.QtWindow(object_id, parent, session)

Bases: enaml.qt.qt_widget.QtWidget

A Qt implementation of an Enaml Window.

create_widget(parent, tree)

Create the underlying QWindow object.

create(tree)

Create and initialize the underlying widget.

init_layout()

Perform layout initialization for the control.

activate()

Activate the window.

central_widget()

Find and return the central widget child for this widget.

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

child_removed(child)

Handle the child removed event for a QtWindow.

child_added(child)

Handle the child added event for a QtWindow.

on_closed()

The signal handler for the ‘closed’ signal.

on_action_close(content)

Handle the ‘close’ action from the Enaml widget.

on_action_maximize(content)

Handle the ‘maximize’ action from the Enaml widget.

on_action_minimize(content)

Handle the ‘minimize’ action from the Enaml widget.

on_action_restore(content)

Handle the ‘restore’ action from the Enaml widget.

on_action_set_icon_source(content)

Handle the ‘set_icon_source’ action from the Enaml widget.

on_action_set_title(content)

Handle the ‘set-title’ action from the Enaml widget.

close()

Close the window

maximize()

Maximize the window.

minimize()

Minimize the window.

restore()

Restore the window after a minimize or maximize.

set_icon_source(icon_source)

Set the window icon source.

set_title(title)

Set the title of the window.

set_initial_size(size)

Set the initial size of the window.

set_visible(visible)

Set the visibility on the window.

This is an overridden parent class method to set the visibility at a later time, so that layout can be initialized before the window is displayed.

Wx

class enaml.wx.wx_window.WxWindow(object_id, parent, session)

Bases: enaml.wx.wx_widget.WxWidget

A Wx implementation of an Enaml Window.

create_widget(parent, tree)

Create the underlying wx.Frame widget.

create(tree)

Create and initialize the window control.

init_layout()

Perform layout initialization for the control.

central_widget()

Find and return the central widget child for this widget.

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

child_removed(child)

Handle the child removed event for a QtWindow.

child_added(child)

Handle the child added event for a QtWindow.

on_close(event)

The event handler for the EVT_CLOSE event.

on_layout_requested(event)

Handle the layout request event from the central widget.

on_action_close(content)

Handle the ‘close’ action from the Enaml widget.

on_action_maximize(content)

Handle the ‘maximize’ action from the Enaml widget.

on_action_minimize(content)

Handle the ‘minimize’ action from the Enaml widget.

on_action_restore(content)

Handle the ‘restore’ action from the Enaml widget.

on_action_set_icon(content)

Handle the ‘set-icon’ action from the Enaml widget.

on_action_set_title(content)

Handle the ‘set-title’ action from the Enaml widget.

on_action_set_modality(content)

Handle the ‘set-modality’ action from the Enaml widget.

close()

Close the window

maximize()

Maximize the window.

minimize()

Minimize the window.

restore()

Restore the window after a minimize or maximize.

set_icon(icon)

Set the window icon.

set_title(title)

Set the title of the window.

set_initial_size(size)

Set the initial size of the window.

set_modality(modality)

Set the modality of the window.

set_visible(visible)

Set the visibility on the window.

This is an overridden parent class method to set the visibility at a later time, so that layout can be initialized before the window is displayed.