unreal.EditableTextBox

class unreal.EditableTextBox(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: Widget

Allows the user to type in custom text. Only permits a single line of text to be entered.

• No Children

• Text Entry

C++ Source:

• Module: UMG

• File: EditableTextBox.h

Editor Properties: (see get_editor_property/set_editor_property)

• accessible_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Behavior: Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

• accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Summary Behavior: How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

• accessible_summary_text (Text): [Read-Write] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

• accessible_text (Text): [Read-Write] Accessible Text: When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

• allow_context_menu (bool): [Read-Write] Allow Context Menu: Whether the context menu can be opened

• can_children_be_accessible (bool): [Read-Write] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.

• clear_keyboard_focus_on_commit (bool): [Read-Write] Clear Keyboard Focus on Commit

• clipping (WidgetClipping): [Read-Write] Clipping

• cursor (MouseCursor): [Read-Write] Cursor

• flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

• hint_text (Text): [Read-Write] Hint Text

• is_caret_moved_when_gain_focus (bool): [Read-Write] Is Caret Moved when Gain Focus

• is_enabled (bool): [Read-Write] Is Enabled

• is_password (bool): [Read-Write] Is Password

• is_read_only (bool): [Read-Write] Is Read Only

• is_volatile (bool): [Read-Write] Is Volatile: If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

• justification (TextJustify): [Read-Write] Justification

• keyboard_type (VirtualKeyboardType): [Read-Write] Keyboard Type: If we’re on a platform that requires a virtual keyboard, what kind of keyboard should this widget use?

• minimum_desired_width (float): [Read-Write] Minimum Desired Width

• navigation (WidgetNavigation): [Read-Write] Navigation: The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

• on_text_changed (OnEditableTextBoxChangedEvent): [Read-Write] On Text Changed: Called whenever the text is changed programmatically or interactively by the user

• on_text_committed (OnEditableTextBoxCommittedEvent): [Read-Write] On Text Committed: Called whenever the text is committed. This happens when the user presses enter or the text box loses focus.

• overflow_policy (TextOverflowPolicy): [Read-Write] Overflow Policy

• override_accessible_defaults (bool): [Read-Write] Override Accessible Defaults: Override all of the default accessibility behavior and text for this widget.

• override_cursor (bool): [Read-Write] Override Cursor

• render_opacity (float): [Read-Write] Render Opacity

• render_transform (WidgetTransform): [Read-Write] Render Transform

• render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

• revert_text_on_escape (bool): [Read-Write] Revert Text on Escape

• select_all_text_on_commit (bool): [Read-Write] Select All Text on Commit

• select_all_text_when_focused (bool): [Read-Write] Select All Text when Focused

• shaped_text_options (ShapedTextOptions): [Read-Write] Shaped Text Options: Controls how the text within this widget should be shaped.

• slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

• text (Text): [Read-Write] Text

• tool_tip_text (Text): [Read-Write] Tool Tip Text

• tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

• virtual_keyboard_dismiss_action (VirtualKeyboardDismissAction): [Read-Write] Virtual Keyboard Dismiss Action: What action should be taken when the virtual keyboard is dismissed?

• virtual_keyboard_options (VirtualKeyboardOptions): [Read-Write] Virtual Keyboard Options: Additional options to use for the virtual keyboard summoned by this widget

• virtual_keyboard_trigger (VirtualKeyboardTrigger): [Read-Write] Virtual Keyboard Trigger: The type of event that will trigger the display of the virtual keyboard

• visibility (SlateVisibility): [Read-Write] Visibility

• widget_style (EditableTextBoxStyle): [Read-Write] Widget Style: The style

clear_error() → None

Clear Error

property clear_keyboard_focus_on_commit: bool

[Read-Write] Clear Keyboard Focus on Commit

Type:

(bool)

get_text() → Text

Gets the widget text

Returns:

The widget text

Return type:

Text

has_error() → bool

Has Error

Return type:

bool

property hint_text: Text

[Read-Write] Hint Text

Type:

(Text)

property is_caret_moved_when_gain_focus: bool

[Read-Write] Is Caret Moved when Gain Focus

Type:

(bool)

property is_password: bool

[Read-Write] Is Password

Type:

(bool)

property is_read_only: bool

[Read-Write] Is Read Only

Type:

(bool)

property justification: TextJustify

[Read-Write] Justification

Type:

(TextJustify)

property minimum_desired_width: float

[Read-Write] Minimum Desired Width

Type:

(float)

property on_text_changed: OnEditableTextBoxChangedEvent

[Read-Write] On Text Changed: Called whenever the text is changed programmatically or interactively by the user

Type:

(OnEditableTextBoxChangedEvent)

property on_text_committed: OnEditableTextBoxCommittedEvent

[Read-Write] On Text Committed: Called whenever the text is committed. This happens when the user presses enter or the text box loses focus.

Type:

(OnEditableTextBoxCommittedEvent)

property overflow_policy: TextOverflowPolicy

[Read-Write] Overflow Policy

Type:

(TextOverflowPolicy)

property revert_text_on_escape: bool

[Read-Write] Revert Text on Escape

Type:

(bool)

property select_all_text_on_commit: bool

[Read-Write] Select All Text on Commit

Type:

(bool)

property select_all_text_when_focused: bool

[Read-Write] Select All Text when Focused

Type:

(bool)

set_error(error) → None

Set Error

Parameters:

error (Text) –

set_foreground_color(color) → None

Set Foreground Color

Parameters:

color (LinearColor) –

set_hint_text(text) → None

Sets the Hint text that appears when there is no text in the text box

Parameters:

text (Text) –

set_is_password(is_password) → None

Set Is Password

Parameters:

is_password (bool) –

set_is_read_only(read_only) → None

Sets the Text as Readonly to prevent it from being modified interactively by the user

Parameters:

read_only (bool) –

set_text(text) → None

Directly sets the widget text. Warning: This will wipe any binding created for the Text property!

Parameters:

text (Text) – The text to assign to the widget

property shaped_text_options: ShapedTextOptions

[Read-Only] Shaped Text Options: Controls how the text within this widget should be shaped.

Type:

(ShapedTextOptions)

property text: Text

[Read-Write] Text

Type:

(Text)

property widget_style: EditableTextBoxStyle

[Read-Write] Widget Style: The style

Type:

(EditableTextBoxStyle)