1. Epic GamesDeveloper
  3. UMultiLineEditableText

UMultiLineEditableText

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/MultiLineEditableText.h
Include #include "Components/MultiLineEditableText.h"

Syntax

class UMultiLineEditableText : public UTextLayoutWidget

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 TSharedPtr< SMultiLineEditableText > MyMultiLineEditableText  
Public variable FOnMultiLineEditableTextChangedEvent OnTextChanged Called whenever the text is changed programmatically or interactively by the user
Public variable FOnMultiLineEditableTextCommittedEvent OnTextCommitted Called whenever the text is committed.
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 FTextBlockStyle WidgetStyle The style

Constructors

  Type Name Description
Public function  

UMultiLineEditableText ( 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 bool Whether to clear text selection when focus is lost
Public function Const const FSlateFontInfo &

GetFont ()

  
Public function Const FText Returns the Hint text that appears when there is no text in the text box
Public function Const bool Return true when this text cannot be modified interactively by the user
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 the user clicks to give focus on the widget
Public function Const FText

GetText ()

 Gets the widget text
Protected function void

HandleOnTextChanged ( const FText& Text
)

  
Protected function void

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

  
Protected function FText  
Public function void

SetClearKeyboardFocusOnCommit ( bool bClearKeyboardFocusOnCommit
)

 Set to true to clear keyboard focus when pressing enter to commit changes
Public function void

SetClearTextSelectionOnFocusLoss ( bool bClearTextSelectionOnFocusLoss
)

 Set to true to clear text selection when focus is lost
Public function void

SetFont ( FSlateFontInfo InFontInfo
)

  
Public function void  
Public function void  
Public function void

SetHintText ( FText InHintText
)

 Sets the Hint text that appears when there is no text in the text box
Public function void

SetIsReadOnly ( bool bReadOnly
)

 Sets the Text as Readonly to prevent it from being modified interactively by the user
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

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

SetWidgetStyle ( const FTextBlockStyle& InWidgetStyle
)

  

Overridden from UTextLayoutWidget

  Type Name Description
Public function Virtual void

SetJustification ( ETextJustify::Type InJustification
)

  

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 FOnMultiLineEditableTextChangedEvent    
Public class FOnMultiLineEditableTextCommittedEvent    

Deprecated Variables

  Type Name Description
Public variable bool bIsReadOnly Direct access to IsReadOnly is deprecated. Please use the getter or setter.
Public variable bool ClearKeyboardFocusOnCommit Direct access to ClearKeyboardFocusOnCommit is deprecated. Please use the getter or setter.
Public variable bool ClearTextSelectionOnFocusLoss Direct access to ClearTextSelectionOnFocusLoss is deprecated. Please use the getter or setter.
Public variable FText HintText Direct access to HintText 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 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