enaml.widgets.container

Classes

Container

A Frame subclass which provides child layout functionality.

class enaml.widgets.container.Container(parent=None, **kwargs)[source]

Bases: enaml.widgets.frame.Frame, enaml.layout.constrainable.ContentsConstrainableMixin

A Frame subclass which provides child layout functionality.

The Container is the canonical component used to arrange child widgets using constraints-based layout. The developer can supply a list of constraints on the container which specify how to layout it’s child widgets.

There are widgets whose boundaries constraints may not cross. Some examples of these would be a ScrollArea or a Notebook. See the documentation of a given widget as to whether or not constraints may cross its boundaries.

share_layout

A boolean which indicates whether or not to allow the layout ownership of this container to be transferred to an ancestor. This is False by default, which means that every container get its own layout solver. This improves speed and reduces memory use (by keeping a solver’s internal tableaux small) but at the cost of not being able to share constraints across Container boundaries. This flag must be explicitly marked as True to enable sharing.

padding

A box object which holds the padding for this component. The padding is the amount of space between the outer boundary box and the content box. The default padding is 10 pixels a side. Certain subclasses, such as GroupBox, may provide additional margin than what is specified by the padding.

resist_width

A Container does not generate constraints for its size hint by default. The minimum and maximum size constraints are sufficient to supply size limits and make for the most natural interaction between nested containers.

proxy

A reference to the ProxyContainer object.

widgets()[source]

Get the child ConstraintsWidgets defined on the container.

visible_widgets()[source]

Get the visible child ConstraintsWidgets on the container.

child_added(child)[source]

Handle the child added event on the container.

This event handler will request a relayout if the added child is an instance of ‘ConstraintsWidget’.

child_moved(child)[source]

Handle the child moved event on the container.

This event handler will request a relayout if the moved child is an instance of ‘ConstraintsWidget’.

child_removed(child)[source]

Handle the child removed event on the container.

This event handler will request a relayout if the removed child is an instance of ‘ConstraintsWidget’.

layout_constraints()[source]

The constraints generation for a Container.

This method supplies default vbox constraints to the visible children of the container unless the user has given explicit ‘constraints’.

This method may also be overridden from Enaml syntax.