unreal.EditableTextBox
¶
- class unreal.EditableTextBox(outer: Object | None = None, name: 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] 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] 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] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.accessible_text
(Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.allow_context_menu
(bool): [Read-Write] Whether the context menu can be openedcan_children_be_accessible
(bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.clear_keyboard_focus_on_commit
(bool): [Read-Write] Whether to clear keyboard focus when pressing enter to commit changesclipping
(WidgetClipping): [Read-Write] 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] The cursor to show when the mouse is over the widgetflow_direction_preference
(FlowDirectionPreference): [Read-Write] Allows you to set a new flow directionhint_text
(Text): [Read-Write] Hint text that appears when there is no text in the text boxis_caret_moved_when_gain_focus
(bool): [Read-Write] Workaround as we lose focus when the auto completion closes.is_enabled
(bool): [Read-Write] Sets whether this widget can be modified interactively by the useris_password
(bool): [Read-Write] Sets whether this text box is for storing a passwordis_read_only
(bool): [Read-Write] Sets the Text Box as Readonly to prevent it from being modified interactively by the useris_volatile
(bool): [Read-Write] 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] How the text should be aligned with the margin.keyboard_type
(VirtualKeyboardType): [Read-Write] 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] The minimum desired size for the textnavigation
(WidgetNavigation): [Read-Write] 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] Called whenever the text is changed programmatically or interactively by the useron_text_committed
(OnEditableTextBoxCommittedEvent): [Read-Write] Called whenever the text is committed. This happens when the user presses enter or the text box loses focus.overflow_policy
(TextOverflowPolicy): [Read-Write] Sets what happens to text that is clipped and doesn’t fit within the clip rect for this widgetoverride_accessible_defaults
(bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.override_cursor
(bool): [Read-Write]pixel_snapping
(WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animationrender_opacity
(float): [Read-Write] The opacity of the widgetrender_transform
(WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.render_transform_pivot
(Vector2D): [Read-Write] 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] Whether to allow the user to back out of changes when they press the escape keyselect_all_text_on_commit
(bool): [Read-Write] Whether to select all text when pressing enter to commit changesselect_all_text_when_focused
(bool): [Read-Write] Whether to select all text when the user clicks to give focus on the widgetshaped_text_options
(ShapedTextOptions): [Read-Write] Controls how the text within this widget should be shaped.slot
(PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.text
(Text): [Read-Write] The text content for this editable text box widgettool_tip_text
(Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mousetool_tip_widget
(Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mousevirtual_keyboard_dismiss_action
(VirtualKeyboardDismissAction): [Read-Write] What action should be taken when the virtual keyboard is dismissed?virtual_keyboard_options
(VirtualKeyboardOptions): [Read-Write] Additional options to use for the virtual keyboard summoned by this widgetvirtual_keyboard_trigger
(VirtualKeyboardTrigger): [Read-Write] The type of event that will trigger the display of the virtual keyboardvisibility
(SlateVisibility): [Read-Write] The visibility of the widgetwidget_style
(EditableTextBoxStyle): [Read-Write] The style
- property clear_keyboard_focus_on_commit: bool¶
[Read-Write] Whether to clear keyboard focus when pressing enter to commit changes
- Type:
(bool)
- property hint_text: Text¶
[Read-Write] Hint text that appears when there is no text in the text box
- Type:
(Text)
- property is_caret_moved_when_gain_focus: bool¶
[Read-Write] Workaround as we lose focus when the auto completion closes.
- Type:
(bool)
- property is_password: bool¶
[Read-Write] Sets whether this text box is for storing a password
- Type:
(bool)
- property is_read_only: bool¶
[Read-Write] Sets the Text Box as Readonly to prevent it from being modified interactively by the user
- Type:
(bool)
- property justification: TextJustify¶
[Read-Write] How the text should be aligned with the margin.
- Type:
- property minimum_desired_width: float¶
[Read-Write] The minimum desired size for the text
- Type:
(float)
- property on_text_changed: OnEditableTextBoxChangedEvent¶
[Read-Write] Called whenever the text is changed programmatically or interactively by the user
- Type:
(OnEditableTextBoxChangedEvent)
- property on_text_committed: OnEditableTextBoxCommittedEvent¶
[Read-Write] 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] Sets what happens to text that is clipped and doesn’t fit within the clip rect for this widget
- Type:
- property revert_text_on_escape: bool¶
[Read-Write] Whether to allow the user to back out of changes when they press the escape key
- Type:
(bool)
- property select_all_text_on_commit: bool¶
[Read-Write] Whether to select all text when pressing enter to commit changes
- Type:
(bool)
- property select_all_text_when_focused: bool¶
[Read-Write] Whether to select all text when the user clicks to give focus on the widget
- Type:
(bool)
- 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_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] Controls how the text within this widget should be shaped.
- Type:
- property widget_style: EditableTextBoxStyle¶
[Read-Write] The style
- Type: