1. Epic GamesDeveloper
  3. UEditableText

UEditableText

Editable text box widget

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

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

Syntax

class UEditableText : public UWidget

Remarks

Editable text box widget

Variables

  Type Name Description
Public variable bool AllowContextMenu Whether the context menu can be opened
Public variable FGetText HintTextDelegate A bindable delegate to allow logic to drive the hint text of the widget
Protected variable FText K2_Cache_HintText  
Protected variable FText K2_Cache_Text  
Public variable TEnumAsByte< EVirtualKeyboardType::Type > KeyboardType If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use?
Protected variable TSharedPtr< SEditableText > MyEditableText  
Public variable FOnEditableTextChangedEvent OnTextChanged Called whenever the text is changed programmatically or interactively by the user
Public variable FOnEditableTextCommittedEvent OnTextCommitted Called whenever the text is committed.
Public variable FShapedTextOptions ShapedTextOptions Controls how the text within this widget should be shaped.
Public variable FGetText TextDelegate A bindable delegate to allow logic to drive the text of the widget
Public variable EVirtualKeyboardDismissAction VirtualKeyboardDismissAction What action should be taken when the virtual keyboard is dismissed?
Public variable FVirtualKeyboardOptions VirtualKeyboardOptions Additional options for the virtual keyboard
Public variable EVirtualKeyboardTrigger VirtualKeyboardTrigger  
Public variable 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 const FSlateFontInfo &

GetFont ()

  
Public function Const 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 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 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 void

SetFont ( FSlateFontInfo InFontInfo
)

  
Public function void  
Public function void  
Public function void

SetHintText ( FText InHintText
)

  
Public function void

SetIsCaretMovedWhenGainFocus ( bool bIsCaretMovedWhenGainFocus
)

 When set to true the caret is moved when gaining focus
Public function void

SetIsPassword ( bool InbIsPassword
)

  
Public function void

SetIsReadOnly ( bool InbIsReadyOnly
)

  
Public function void

SetJustification ( ETextJustify::Type InJustification
)

  
Public function void  
Public function 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 void

SetText ( FText InText
)

 Directly sets the widget text.
Public function 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
Protected function Virtual Const TSharedPtr< SWidget > Gets the widget that accessibility properties should synchronize to.
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    

Deprecated Variables

  Type Name Description
Public variable bool ClearKeyboardFocusOnCommit Direct access to ClearKeyboardFocusOnCommit is deprecated. Please use the getter or setter.
Public variable FText HintText Direct access to Hint Text is deprecated. Please use the getter or setter.
Public variable bool IsCaretMovedWhenGainFocus Direct access to IsCaretMovedWhenGainFocus is deprecated. Please use the getter or setter.
Public variable bool IsPassword Direct access to IsPassword is deprecated. Please use the getter or setter.
Public variable bool IsReadOnly Direct access to IsReadOnly is deprecated. Please use the getter or setter.
Public variable TEnumAsByte< ETextJustify::Type > Justification Direct access to Justification is deprecated. Please use the getter or setter.
Public variable float MinimumDesiredWidth Direct access to MinimumDesiredWidth is deprecated. Please use the getter or setter.
Public variable ETextOverflowPolicy OverflowPolicy Direct access to OverflowPolicy is deprecated. Please use the getter or setter.
Public variable bool RevertTextOnEscape Direct access to RevertTextOnEscape is deprecated. Please use the getter or setter.
Public variable bool SelectAllTextOnCommit Direct access to SelectAllTextOnCommit is deprecated. Please use the getter or setter.
Public variable bool SelectAllTextWhenFocused Direct access to SelectAllTextWhenFocused is deprecated. Please use the getter or setter.
Public variable FText Text Direct access to Text is deprecated. Please use the getter or setter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page