unreal.EditableText

class unreal.EditableText(outer=None, name='None')

Bases: unreal.Widget

Editable text box widget

C++ Source:

  • Module: UMG

  • File: EditableText.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: Whether to clear keyboard focus when pressing enter to commit changes

  • clipping (WidgetClipping): [Read-Write] Clipping: Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

    NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

  • cursor (MouseCursor): [Read-Write] Cursor: The cursor to show when the mouse is over the widget

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference: Allows you to set a new flow direction

  • hint_text (Text): [Read-Write] Hint Text: Hint text that appears when there is no text in the text box

  • is_caret_moved_when_gain_focus (bool): [Read-Write] Is Caret Moved when Gain Focus: Workaround as we lose focus when the auto completion closes.

  • is_enabled (bool): [Read-Write] Is Enabled: Sets whether this widget can be modified interactively by the user

  • is_password (bool): [Read-Write] Is Password: Sets whether this text box is for storing a password

  • is_read_only (bool): [Read-Write] Is Read Only: Sets whether this text box can actually be modified interactively by the user

  • 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: How the text should be aligned with the margin.

  • 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: Minimum width that a text block should be

  • 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 (OnEditableTextChangedEvent): [Read-Write] On Text Changed: Called whenever the text is changed programmatically or interactively by the user

  • on_text_committed (OnEditableTextCommittedEvent): [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: Sets what should happen when text is clipped because the block does not have enough space

  • 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: The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] Render Transform: The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot: The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.

  • revert_text_on_escape (bool): [Read-Write] Revert Text on Escape: Whether to allow the user to back out of changes when they press the escape key

  • select_all_text_on_commit (bool): [Read-Write] Select All Text on Commit: Whether to select all text when pressing enter to commit changes

  • select_all_text_when_focused (bool): [Read-Write] Select All Text when Focused: Whether to select all text when the user clicks to give focus on the widget

  • 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: The text content for this editable text box widget

  • tool_tip_text (Text): [Read-Write] Tool Tip Text: Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mouse

  • 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 for the virtual keyboard

  • virtual_keyboard_trigger (VirtualKeyboardTrigger): [Read-Write] Virtual Keyboard Trigger

  • visibility (SlateVisibility): [Read-Write] Visibility: The visibility of the widget

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

get_text() → Text

Gets the widget text

Returns

The widget text

Return type

Text

property hint_text

[Read-Only] Hint Text: Hint text that appears when there is no text in the text box

Type

(Text)

property justification

[Read-Write] Justification: How the text should be aligned with the margin.

Type

(TextJustify)

property on_text_changed

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

Type

(OnEditableTextChangedEvent)

property on_text_committed

[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

(OnEditableTextCommittedEvent)

property overflow_policy

[Read-Write] Overflow Policy: Sets what should happen when text is clipped because the block does not have enough space

Type

(TextOverflowPolicy)

set_hint_text(hint_text) → None

Set Hint Text

Parameters

hint_text (Text) –

set_is_password(inb_is_password) → None

Set Is Password

Parameters

inb_is_password (bool) –

set_is_read_only(inb_is_ready_only) → None

Set Is Read Only

Parameters

inb_is_ready_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

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

Type

(ShapedTextOptions)

property widget_style

[Read-Write] Widget Style: The style

Type

(EditableTextStyle)