1. Epic GamesDeveloper
  3. UEditableTextBox

UEditableTextBox

Allows the user to type in custom text.

API > API/Runtime > API/Runtime/UMG

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

  • No Children
  • Text Entry
   
Name UEditableTextBox
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/EditableTextBox.h
Include Path #include "Components/EditableTextBox.h"

Syntax

UCLASS (Meta=(DisplayName="Text Box"), MinimalAPI)  
class UEditableTextBox : public UWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UEditableTextBox ( const FObjectInitializer& ObjectInitializer
)

   Components/EditableTextBox.h  

Classes

Name Remarks
FOnEditableTextBoxChangedEvent  
FOnEditableTextBoxCommittedEvent  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllowContextMenu bool Whether the context menu can be opened Components/EditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
ClearKeyboardFocusOnCommit bool Whether to clear keyboard focus when pressing enter to commit changes Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
HintText FText Hint text that appears when there is no text in the text box Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetHintText"
  • Category=Content
  • Meta=(MultiLine="true")
HintTextDelegate FGetText A bindable delegate to allow logic to drive the hint text of the widget Components/EditableTextBox.h  
IsCaretMovedWhenGainFocus bool Workaround as we lose focus when the auto completion closes. Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
IsPassword bool Sets whether this text box is for storing a password Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetIsPassword"
  • Category=Appearance
IsReadOnly bool Sets the Text Box as Readonly to prevent it from being modified interactively by the user Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Appearance
Justification TEnumAsByte< ETextJustify::Type > How the text should be aligned with the margin. Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetJustification
  • Category=Appearance
KeyboardType TEnumAsByte< EVirtualKeyboardType::Type > If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use? Components/EditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
MinimumDesiredWidth float The minimum desired size for the text Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter=SetMinDesiredWidth
  • Category="Appearance"
OnTextChanged FOnEditableTextBoxChangedEvent Called whenever the text is changed programmatically or interactively by the user Components/EditableTextBox.h
  • BlueprintAssignable
  • Category="TextBox|Event"
OnTextCommitted FOnEditableTextBoxCommittedEvent Called whenever the text is committed. Components/EditableTextBox.h
  • BlueprintAssignable
  • Category="TextBox|Event"
OverflowPolicy ETextOverflowPolicy Sets what happens to text that is clipped and doesn't fit within the clip rect for this widget Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetTextOverflowPolicy"
  • Setter="SetTextOverflowPolicy"
  • BlueprintSetter="SetTextOverflowPolicy"
  • Category="Clipping"
  • AdvancedDisplay
  • Meta=(DisplayName="Overflow Policy")
RevertTextOnEscape bool Whether to allow the user to back out of changes when they press the escape key Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
SelectAllTextOnCommit bool Whether to select all text when pressing enter to commit changes Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
SelectAllTextWhenFocused bool Whether to select all text when the user clicks to give focus on the widget Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Behavior
  • AdvancedDisplay
ShapedTextOptions FShapedTextOptions Controls how the text within this widget should be shaped. Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Localization
  • AdvancedDisplay
  • Meta=(ShowOnlyInnerProperties)
Text FText The text content for this editable text box widget Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintGetter="GetText"
  • BlueprintSetter="SetText"
  • FieldNotify
  • Category="Content"
TextDelegate FGetText A bindable delegate to allow logic to drive the text of the widget Components/EditableTextBox.h  
VirtualKeyboardDismissAction EVirtualKeyboardDismissAction What action should be taken when the virtual keyboard is dismissed? Components/EditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
VirtualKeyboardOptions FVirtualKeyboardOptions Additional options to use for the virtual keyboard summoned by this widget Components/EditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
VirtualKeyboardTrigger EVirtualKeyboardTrigger The type of event that will trigger the display of the virtual keyboard Components/EditableTextBox.h
  • EditAnywhere
  • Category=Behavior
  • AdvancedDisplay
WidgetStyle FEditableTextBoxStyle The style Components/EditableTextBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Appearance
  • Meta=(DisplayName="Style", ShowOnlyInnerProperties)

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsFontDeprecationDone bool   Components/EditableTextBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearError()

   Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"

bool GetClearKeyboardFocusOnCommit()

 Whether to clear keyboard focus when pressing enter to commit changes Components/EditableTextBox.h  

FText GetHintText()

 Gets the Hint text that appears when there is no text in the text box Components/EditableTextBox.h  

bool GetIsCaretMovedWhenGainFocus()

 Return true when the caret is moved when gaining focus Components/EditableTextBox.h  

bool GetIsPassword()

   Components/EditableTextBox.h  

bool GetIsReadOnly()

 Return true when this text cannot be modified interactively by the user Components/EditableTextBox.h  

ETextJustify::Type GetJustification()

   Components/EditableTextBox.h  

float GetMinimumDesiredWidth()

   Components/EditableTextBox.h  

bool GetRevertTextOnEscape()

 Whether to allow the user to back out of changes when they press the escape key Components/EditableTextBox.h  

bool GetSelectAllTextOnCommit()

 Whether to select all text when pressing enter to commit changes Components/EditableTextBox.h  

bool GetSelectAllTextWhenFocused()

 Whether to select all text when the user clicks to give focus on the widget Components/EditableTextBox.h  

FText GetText()

 Provide a alternative mechanism for error reporting. Gets the widget text Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="GetText (Text Box)")

ETextOverflowPolicy GetTextOverflowPolicy()

   Components/EditableTextBox.h  

const FEditableTextBoxStyle & GetWidgetStyle()

   Components/EditableTextBox.h  

bool HasError()

   Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"

void SetClearKeyboardFocusOnCommit ( bool bClearKeyboardFocusOnCommit
)

 Set to true to clear keyboard focus when pressing enter to commit changes Components/EditableTextBox.h  

void SetError ( FText InError
)

   Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetError (Text Box)")

void SetForegroundColor ( FLinearColor color
)

   Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetForegroundColor (Text Box)")

void SetHintText ( FText InText
)

 Sets the Hint text that appears when there is no text in the text box Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="Set Hint Text (Text Box)")

void SetIsCaretMovedWhenGainFocus ( bool bIsCaretMovedWhenGainFocus
)

 When set to true the caret is moved when gaining focus Components/EditableTextBox.h  

void SetIsPassword ( bool bIsPassword
)

   Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="IsPassword")

void SetIsReadOnly ( bool bReadOnly
)

 Sets the Text as Readonly to prevent it from being modified interactively by the user Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetIsReadOnly (Editable Text)")

void SetJustification ( ETextJustify::Type InJustification
)

   Components/EditableTextBox.h
  • BlueprintSetter

void SetMinDesiredWidth ( float InMinDesiredWidth
)

 Set the minimum desired width for this text box Components/EditableTextBox.h  

void SetRevertTextOnEscape ( bool bRevertTextOnEscape
)

 Set to true to allow the user to back out of changes when they press the escape key Components/EditableTextBox.h  

void SetSelectAllTextOnCommit ( bool bSelectAllTextOnCommit
)

 Set to true to select all text when pressing enter to commit changes Components/EditableTextBox.h  

void SetSelectAllTextWhenFocused ( bool bSelectAllTextWhenFocused
)

 Set to true to select all text when the user clicks to give focus on the widget Components/EditableTextBox.h  

void SetText ( FText InText
)

 Directly sets the widget text. Components/EditableTextBox.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="SetText (Text Box)")

void SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolicy
)

 Set the text overflow policy for this text box. Components/EditableTextBox.h
  • BlueprintSetter

void SetWidgetStyle ( const FEditableTextBoxStyle& InStyle
)

   Components/EditableTextBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/EditableTextBox.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/EditableTextBox.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/EditableTextBox.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

   Components/EditableTextBox.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void HandleOnTextChanged ( const FText& Text
)

   Components/EditableTextBox.h  

virtual void HandleOnTextCommitted ( const FText& Text,
ETextCommit::Type CommitMethod
)

   Components/EditableTextBox.h  

FText K2_Gate_HintText()

   Components/EditableTextBox.h  

FText K2_Gate_Text()

   Components/EditableTextBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< SWidget > GetAccessibleWidget()

 Gets the widget that accessibility properties should synchronize to. Components/EditableTextBox.h  

virtual TSharedRef< SWidget > RebuildWidget()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page