Field

class enaml.widgets.field.Field(parent=None, **kwargs)

Bases: enaml.widgets.control.Control

A single line editable text widget.

text = None

The unicode text to display in the field.

mask = None

The mask to use for text input. TODO - describe and implement this mask

validator = None

The validator to use for this field. If the validator provides a client side validator, then text will only be submitted if it passes that validator.

submit_triggers = None

The list of actions which should cause the client to submit its text to the server for validation and update. The currently supported values are ‘lost_focus’ and ‘return_pressed’.

placeholder = None

The grayed-out text to display if the field is empty and the widget doesn’t have focus. Defaults to the empty string.

echo_mode = None

How to display the text in the field. Valid values are ‘normal’ which displays the text as normal, ‘password’ which displays the text with an obscured character, and ‘silent’ which displays no text at all but still allows input.

max_length = None

The maximum length of the field in characters. The default value is Zero and indicates there is no maximum length.

read_only = None

Whether or not the field is read only. Defaults to False.

hug_width = None

How strongly a component hugs it’s contents’ width. Fields ignore the width hug by default, so they expand freely in width.

snapshot()

Returns the snapshot dict for the field.

bind()

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

on_action_submit_text(content)

Handle the ‘submit_text’ action from the client widget.

__implements__

alias of __NoInterface__

Backends

Qt

class enaml.qt.qt_field.QtField(object_id, parent, session)

Bases: enaml.qt.qt_control.QtControl

A Qt4 implementation of an Enaml Field.

create_widget(parent, tree)

Creates the underlying QLineEdit widget.

create(tree)

Create and initialize the underlying widget.

on_lost_focus()

The signal handler for ‘lostFocus’ signal.

on_return_pressed()

The signal handler for ‘returnPressed’ signal.

on_action_set_text(content)

Handle the ‘set_text’ action from the Enaml widget.

on_action_set_validator(content)

Handle the ‘set_validator’ action from the Enaml widget.

on_action_set_submit_triggers(content)

Handle the ‘set_submit_triggers’ action from the Enaml widget.

on_action_set_placeholder(content)

Hanlde the ‘set_placeholder’ action from the Enaml widget.

on_action_set_echo_mode(content)

Handle the ‘set_echo_mode’ action from the Enaml widget.

on_action_set_max_length(content)

Handle the ‘set_max_length’ action from the Enaml widget.

on_action_set_read_only(content)

Handle the ‘set_read_only’ action from the Enaml widget.

on_action_invalid_text(content)

Handle the ‘invalid_text’ action from the Enaml widget.

set_text(text)

Set the text in the underlying widget.

set_validator(validator)

Set the validator for the underlying widget.

set_submit_triggers(triggers)

Set the submit triggers for the underlying widget.

set_placeholder(text)

Set the placeholder text of the underlying widget.

set_echo_mode(mode)

Set the echo mode of the underlying widget.

set_max_length(length)

Set the maximum text length in the underlying widget.

set_read_only(read_only)

Set whether or not the widget is read only.

Wx

class enaml.wx.wx_field.WxField(object_id, parent, session)

Bases: enaml.wx.wx_control.WxControl

A Wx implementation of an Enaml Field.

create_widget(parent, tree)

Creates the underlying wxLineEdit.

create(tree)

Create and initialize the wx field control.

on_lost_focus(event)

The event handler for EVT_KILL_FOCUS event.

on_return_pressed(event)

The event handler for EVT_TEXT_ENTER event.

on_action_set_text(content)

Handle the ‘set_text’ action from the Enaml widget.

on_action_set_validator(content)

Handle the ‘set_validator’ action from the Enaml widget.

on_action_set_submit_triggers(content)

Handle the ‘set_submit_triggers’ action from the Enaml widget.

on_action_set_placeholder(content)

Hanlde the ‘set_placeholder’ action from the Enaml widget.

on_action_set_echo_mode(content)

Handle the ‘set_echo_mode’ action from the Enaml widget.

on_action_set_max_length(content)

Handle the ‘set_max_length’ action from the Enaml widget.

on_action_set_read_only(content)

Handle the ‘set_read_only’ action from the Enaml widget.

on_action_invalid_text(content)

Handle the ‘invalid_text’ action from the Enaml widget.

set_text(text)

Updates the text control with the given unicode text.

set_validator(validator)

Sets the validator for the control.

set_submit_triggers(triggers)

Set the submit triggers for the underlying widget.

set_placeholder(placeholder)

Sets the placeholder text in the widget.

set_echo_mode(echo_mode)

Sets the echo mode of the wiget.

set_max_length(max_length)

Set the max length of the control to max_length. If the max length is <= 0 or > 32767 then the control will be set to hold 32kb of text.

set_read_only(read_only)

Sets the read only state of the widget.