UEditableTextBox

Allows the user to type in custom text.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Components/EditableTextBox.h

Include

#include "Components/EditableTextBox.h"

Syntax

class UEditableTextBox : public UWidget

Remarks

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

No Children Text Entry

Variables

Name Description

Public variable

bool

 

AllowContextMenu

Whether the context menu can be opened

Public variable

bool

 

ClearKeyboardFocusOnCommit

Whether to clear keyboard focus when pressing enter to commit changes

Public variable

FText

 

HintText

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

Public variable

FGetText

 

HintTextDelegate

A bindable delegate to allow logic to drive the hint text of the widget

Public variable

bool

 

IsCaretMovedWhenGainFocus

Workaround as we lose focus when the auto completion closes.

Public variable

bool

 

IsPassword

Sets whether this text box is for storing a password

Public variable

bool

 

IsReadOnly

Sets whether this text box can actually be modified interactively by the user

Public variable

TEnumAsByte< ET...

 

Justification

How the text should be aligned with the margin.

Protected variable

FText

 

K2_Cache_HintText

Protected variable

FText

 

K2_Cache_Text

Public variable

TEnumAsByte< EV...

 

KeyboardType

If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use?

Public variable

float

 

MinimumDesiredWidth

Minimum width that a text block should be

Protected variable

TSharedPtr< SEd...

 

MyEditableTextBlock

Public variable

FOnEditableText...

 

OnTextChanged

Called whenever the text is changed programmatically or interactively by the user

Public variable

FOnEditableText...

 

OnTextCommitted

Called whenever the text is committed.

Public variable

ETextOverflowPo...

 

OverflowPolicy

Sets what should happen when text is clipped because the block does not have enough space

Public variable

bool

 

RevertTextOnEscape

Whether to allow the user to back out of changes when they press the escape key

Public variable

bool

 

SelectAllTextOnCommit

Whether to select all text when pressing enter to commit changes

Public variable

bool

 

SelectAllTextWhenFocused

Whether to select all text when the user clicks to give focus on the widget

Public variable

FShapedTextOpti...

 

ShapedTextOptions

Controls how the text within this widget should be shaped.

Public variable

FText

 

Text

The text content for this editable text box widget

Public variable

FGetText

 

TextDelegate

A bindable delegate to allow logic to drive the text of the widget

Public variable

EVirtualKeyboar...

 

VirtualKeyboardDismissAction

What action should be taken when the virtual keyboard is dismissed?

Public variable

FVirtualKeyboar...

 

VirtualKeyboardOptions

Additional options to use for the virtual keyboard summoned by this widget

Public variable

EVirtualKeyboar...

 

VirtualKeyboardTrigger

The type of event that will trigger the display of the virtual keyboard

Public variable

FEditableTextBo...

 

WidgetStyle

The style

Constructors

Name Description

Public function

UEditableTextBox

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

ClearError()

Public function Const

FText

 

GetText()

Provide a alternative mechanism for error reporting.

Protected function Virtual

void

 

HandleOnTextChanged

(
    const FText& Text
)

Protected function Virtual

void

 

HandleOnTextCommitted

(
    const FText& Text,
    ETextCommit::Type CommitMethod
)

Public function Const

bool

 

HasError()

Protected function

FText

 

K2_Gate_HintText()

Protected function

FText

 

K2_Gate_Text()

Public function

void

 

SetError

(
    FText InError
)

Public function

void

 

SetForegroundColor

(
    FLinearColor color
)

Public function

void

 

SetHintText

(
    FText InText
)

Public function

void

 

SetIsPassword

(
    bool bIsPassword
)

Public function

void

 

SetIsReadOnly

(
    bool bReadOnly
)

Public function

void

 

SetJustification

(
    ETextJustify::Type InJustification
)

Public function

void

 

SetText

(
    FText InText
)

Public function

void

 

SetTextOverflowPolicy

(
    ETextOverflowPolicy InOverflowPolic...
)

Overridden from UWidget

Name Description

Protected function Virtual Const

TSharedPtr< ...

 

GetAccessibleWidget()

Gets the widget that accessibility properties should synchronize to.

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Classes

Deprecated Variables

Name Description

Public variable

FLinearColor

 

BackgroundColor_DEPRECATED

The color of the background/border around the editable text (overrides Style)

Public variable

FSlateFontInfo

 

Font_DEPRECATED

Font color and opacity (overrides Style)

Public variable

FLinearColor

 

ForegroundColor_DEPRECATED

Text color and opacity (overrides Style)

Public variable

FMargin

 

Padding_DEPRECATED

Padding between the box/border and the text widget inside (overrides Style)

Public variable

FLinearColor

 

ReadOnlyForegroundColor_DEPRECATED

Text color and opacity when read-only (overrides Style)

Public variable

TObjectPtr< USl...

 

Style_DEPRECATED

Style used for the text box