1. Epic GamesDeveloper
  3. UEditableText

UEditableText

Editable text box widget

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/EditableText.h
Include #include "Components/EditableText.h"

Syntax

UCLASS (MinimalAPI)  
class UEditableText : public UWidget

Remarks

Editable text box widget

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool AllowContextMenu Whether the context menu can be opened
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool ClearKeyboardFocusOnCommit Whether to clear keyboard focus when pressing enter to commit changes
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter FText HintText Hint text that appears when there is no text in the text box
Public variable UProperty FGetText HintTextDelegate A bindable delegate to allow logic to drive the hint text of the widget
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool IsCaretMovedWhenGainFocus When set to true the caret is moved when gaining focus
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool IsPassword Sets whether this text box is for storing a password
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool IsReadOnly Sets whether this text box can actually be modified interactively by the user
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter TEnumAsByte< ETextJustify::Type > Justification How the text should be aligned with the margin.
Protected variable FText K2_Cache_HintText  
Protected variable FText K2_Cache_Text  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay TEnumAsByte< EVirtualKeyboardType::Type > KeyboardType If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use?
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter float MinimumDesiredWidth The minimum desired Width for the text
Protected variable TSharedPtr< SEditableText > MyEditableText  
Public variable UProperty Category, Meta BlueprintAssignable FOnEditableTextChangedEvent OnTextChanged Called whenever the text is changed programmatically or interactively by the user
Public variable UProperty Category, Meta BlueprintAssignable FOnEditableTextCommittedEvent OnTextCommitted Called whenever the text is committed.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite blueprintsetter, getter, setter ETextOverflowPolicy OverflowPolicy Sets what happens to text that is clipped and doesn't fit within the clip rect for this widget
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool RevertTextOnEscape Whether to allow the user to back out of changes when they press the escape key
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool SelectAllTextOnCommit Whether to select all text when pressing enter to commit changes
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool SelectAllTextWhenFocused Whether to select all text when the user clicks to give focus on the widget
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly FShapedTextOptions ShapedTextOptions Controls how the text within this widget should be shaped.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter, fieldnotify, getter, setter FText Text The text content for this editable text box widget
Public variable UProperty FGetText TextDelegate A bindable delegate to allow logic to drive the text of the widget
Public variable UProperty Category, EditAnywhere, AdvancedDisplay EVirtualKeyboardDismissAction VirtualKeyboardDismissAction What action should be taken when the virtual keyboard is dismissed?
Public variable UProperty Category, EditAnywhere, AdvancedDisplay FVirtualKeyboardOptions VirtualKeyboardOptions Additional options for the virtual keyboard
Public variable UProperty Category, EditAnywhere, AdvancedDisplay EVirtualKeyboardTrigger VirtualKeyboardTrigger  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite setter FEditableTextStyle WidgetStyle The style

Constructors

  Type Name Description
Public function  

UEditableText ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool Whether to clear keyboard focus when pressing enter to commit changes
Public function Const UFunction BlueprintCallable, Category const FSlateFontInfo &

GetFont ()

  
Public function Const UFunction BlueprintCallable, Category, Meta FText Gets the Hint text that appears when there is no text in the text box
Public function Const bool Return true when the caret is moved when gaining focus
Public function Const bool  
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category ETextJustify::Type  
Public function Const float  
Public function Const bool Whether to allow the user to back out of changes when they press the escape key
Public function Const bool Whether to select all text when pressing enter to commit changes
Public function Const bool Whether to select all text when the user clicks to give focus on the widget
Public function Const UFunction BlueprintCallable, Category, Meta FText

GetText ()

 Gets the widget text
Public function Const ETextOverflowPolicy  
Protected function void

HandleOnTextChanged ( const FText& Text
)

  
Protected function void

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

  
Protected function FText  
Protected function FText  
Public function void

SetClearKeyboardFocusOnCommit ( bool bInClearKeyboardFocusOnCommit
)

 Set to true to clear keyboard focus when pressing enter to commit changes
Public function UFunction BlueprintCallable, Category void

SetFont ( FSlateFontInfo InFontInfo
)

  
Public function UFunction BlueprintCallable, Category void

SetFontMaterial ( UMaterialInterface* InMaterial
)

  
Public function UFunction BlueprintCallable, Category void

SetFontOutlineMaterial ( UMaterialInterface* InMaterial
)

  
Public function UFunction BlueprintCallable, Category void

SetHintText ( FText InHintText
)

  
Public function void

SetIsCaretMovedWhenGainFocus ( bool bIsCaretMovedWhenGainFocus
)

 When set to true the caret is moved when gaining focus
Public function UFunction BlueprintCallable, Category void

SetIsPassword ( UPARAM(DisplayName="IsPassword") bool InbIsPassword
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetIsReadOnly ( UPARAM(DisplayName="ReadyOnly") bool InbIsReadyOnly
)

  
Public function UFunction blueprintsetter void

SetJustification ( ETextJustify::Type InJustification
)

  
Public function void  
Public function UFunction BlueprintCallable, Category void

SetMinimumDesiredWidth ( float InMinDesiredWidth
)

 Set the minimum desired width for this text box
Public function void

SetRevertTextOnEscape ( bool bRevertTextOnEscape
)

 Set to true to allow the user to back out of changes when they press the escape key
Public function void

SetSelectAllTextOnCommit ( bool bSelectAllTextOnCommit
)

 Set to true to select all text when pressing enter to commit changes
Public function void

SetSelectAllTextWhenFocused ( bool bSelectAllTextWhenFocused
)

 Set to true to select all text when the user clicks to give focus on the widget
Public function UFunction BlueprintCallable, Category, Meta void

SetText ( FText InText
)

 Directly sets the widget text.
Public function UFunction blueprintsetter void

SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolicy
)

  
Public function void

SetWidgetStyle ( const FEditableTextStyle& InEditableTextStyle
)

 Set the style and ensure the visual will be updated accordingly

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FOnEditableTextChangedEvent    
Public class FOnEditableTextCommittedEvent    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page