Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Text > SMultiLineEditableText

Light Theme

Dark Theme

SMultiLineEditableText

An editable text widget that supports multiple lines and soft word-wrapping.

Windows

MacOS

Linux

Inheritance Hierarchy

SWidget

ISlateEditableTextWidget

SMultiLineEditableText

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Text/SMultiLineEditableText.h
Include	#include "Widgets/Text/SMultiLineEditableText.h"

Syntax

class SMultiLineEditableText :
public SWidget,
public ISlateEditableTextWidget

Remarks

An editable text widget that supports multiple lines and soft word-wrapping.

Variables

	Name	Description
TWeakPtr< FActi...	ActiveTickTimer	The timer that is actively driving this widget to Tick() even when Slate is idle
float	AmountScrolledWhileRightMouseDown	How much we scrolled while RMB was being held
TAttribute< boo...	bAllowContextMenu	Whether the context menu can be opened
TAttribute< boo...	bAllowMultiLine	Whether to allow multi-line text
TAttribute< boo...	bClearKeyboardFocusOnCommit	True if we want the text control to lose focus on an text commit/revert events
TAttribute< boo...	bClearTextSelectionOnFocusLoss	Whether to clear text selection when focus is lost
TAttribute< boo...	bIsReadOnly	Sets whether this text box can actually be modified interactively by the user
bool	bIsSoftwareCursor	Whether a software cursor is currently active
TAttribute< boo...	bRevertTextOnEscape	True if any changes should be reverted if we receive an escape key
TAttribute< boo...	bSelectAllTextWhenFocused	Whether to select all text when the user clicks to give focus on the widget
TAttribute< boo...	bSelectWordOnMouseDoubleClick	Whether to select work on mouse double click
TUniquePtr< FSl...	EditableTextLayout	The text layout that deals with the editable text
TSharedPtr< SSc...	HScrollBar	The horizontal scroll bar widget
TSharedPtr< FEx...	MenuExtender	Menu extender for right-click context menu
EModifierKey::T...	ModiferKeyForNewLine	The optional modifier key necessary to create a newline when typing into the editor.
FOnContextMenuO...	OnContextMenuOpening	Delegate to call before a context menu is opened
FOnCursorMoved	OnCursorMovedCallback	Called when the cursor is moved within the text area
FOnUserScrolled	OnHScrollBarUserScrolled	Called whenever the horizontal scrollbar is moved by the user
FOnIsTypedCharV...	OnIsTypedCharValid	Called when a character is typed and we want to know if the text field supports typing this character.
FOnKeyChar	OnKeyCharHandler	Callback delegate to have first chance handling of the OnKeyChar event
FOnKeyDown	OnKeyDownHandler	Callback delegate to have first chance handling of the OnKeyDown event
FOnTextChanged	OnTextChangedCallback	Called whenever the text is changed programmatically or interactively by the user
FOnTextCommitte...	OnTextCommittedCallback	Called whenever the text is committed.
FOnUserScrolled	OnVScrollBarUserScrolled	Called whenever the vertical scrollbar is moved by the user
FVector2D	SoftwareCursorPosition	The current position of the software cursor
TAttribute< EVi...	VirtualKeyboardDismissAction	The message action to take when the virtual keyboard is dismissed by the user
FVirtualKeyboar...	VirtualKeyboardOptions	Options to use for the virtual keyboard summoned by this widget
TAttribute< EVi...	VirtualKeyboardTrigger	The type of event that will trigger the display of the virtual keyboard
TSharedPtr< SSc...	VScrollBar	The vertical scroll bar widget

Constructors

	Name	Description
	SMultiLineEditableText()

Destructors

	Name	Description
	~SMultiLineEditableText()

Functions

	Name	Description
void	AdvanceSearch ( const bool InReverse )	Advance the current search to the next match (does nothing if not currently searching)
bool	AnyTextSelected()	Query to see if any text is selected within the document
void	ApplyToSelection ( const FRunInfo& InRunInfo, const FTextBlockStyle& InStyle )	Apply the given style to the currently selected text (or insert a new run at the current cursor position if no text is selected)
void	BeginSearch ( const FText& InSearchText, const ESearchCase::Type InSearchCas..., const bool InReverse )	Begin a new text search (this is called automatically when the bound search text changes)
void	ClearSelection()	Clear the active text selection
void	Construct ( const FArguments& InArgs )
void	ForceScroll ( int32 UserIndex, float ScrollAxisMagnitude )	Force a single scroll operation.
void	GetCurrentTextLine ( FString& OutTextLine )	Fill OutTextLine with the text line where the current cursor location is at
FText	GetHintText()	Get the text that appears when there is no text in the text box
TSharedPtr< ...	GetHScrollBar()	Get the horizontal scroll bar widget
FText	GetPlainText()	Returns the plain text string without richtext formatting
TSharedPtr< ...	GetRunUnderCursor()	Get the run currently under the cursor, or null if there is no run currently under the cursor
FText	GetSearchText()	Get the text that is currently being searched for (if any)
TArray< TSha...	GetSelectedRuns()	Get the runs currently that are current selected, some of which may be only partially selected
FText	GetSelectedText()	Get the currently selected text
FText	GetText()	Returns the text string
TSharedPtr< ...	GetVScrollBar()	Get the vertical scroll bar widget
void	GoTo ( const ETextLocation NewLocation )	Move the cursor specified location
void	GoTo ( const FTextLocation& NewLocation )	Move the cursor to the given location in the document (will also scroll to this point)
void	InsertRunAtCursor ( TSharedRef< IRun > InRun )	Insert the given run at the current cursor position
void	InsertTextAtCursor ( const FText& InText )	Insert the given text at the current cursor position, correctly taking into account new line characters
void	InsertTextAtCursor ( const FString& InString )	Insert the given text at the current cursor position, correctly taking into account new line characters
bool	IsRightClickScrolling()	Return whether a RMB+Drag scroll operation is taking place
void	OnHScrollBarMoved ( const float InScrollOffsetFraction )
void	OnVScrollBarMoved ( const float InScrollOffsetFraction )
void	Refresh()	Refresh this editable text immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick
void	ScrollTo ( const FTextLocation& NewLocation )	Scroll to the given location in the document (without moving the cursor)
void	ScrollTo ( const ETextLocation NewLocation )	Scroll to the given location in the document (without moving the cursor)
void	SelectAllText()	Select all the text in the document
void	SetAllowContextMenu ( const TAttribute< bool >& InAllowC... )	See the AllowContextMenu attribute
void	SetAutoWrapText ( const TAttribute< bool >& InAutoWr... )	See AutoWrapText attribute
void	SetClearKeyboardFocusOnCommit ( const TAttribute< bool >& InClearK... )	Sets whether to clear keyboard focus when pressing enter to commit changes
void	SetClearTextSelectionOnFocusLoss ( const TAttribute< bool >& InClearT... )	Sets whether to clear text selection when focus is lost
void	SetFont ( const TAttribute< FSlateFontInfo > ... )	See attribute Font
void	SetHintText ( const TAttribute< FText >& InHintT... )	Sets the text that appears when there is no text in the text box
void	SetIsReadOnly ( const TAttribute< bool >& InIsRead... )	Sets the ReadOnly attribute
void	SetJustification ( const TAttribute< ETextJustify::Typ... )	See Justification attribute
void	SetLineHeightPercentage ( const TAttribute< float >& InLineH... )	See LineHeightPercentage attribute
void	SetMargin ( const TAttribute< FMargin >& InMar... )	See Margin attribute
void	SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler )	Sets the OnKeyCharHandler to provide first chance handling of the OnKeyChar event
void	SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler )	Sets the OnKeyDownHandler to provide first chance handling of the OnKeyDown event
void	SetRevertTextOnEscape ( const TAttribute< bool >& InRevert... )	Sets whether to allow the user to back out of changes when they press the escape key
void	SetSearchText ( const TAttribute< FText >& InSearc... )	Set the text that is currently being searched for (if any)
void	SetSelectAllTextWhenFocused ( const TAttribute< bool >& InSelect... )	Sets whether to select all text when the user clicks to give focus on the widget
void	SetSelectWordOnMouseDoubleClick ( const TAttribute< bool >& InSelect... )	Sets whether to select word on the mouse double click
void	SetText ( const TAttribute< FText >& InText )	Sets the text for this text block
void	SetTextFlowDirection ( const TOptional< ETextFlowDirection... )	See TextFlowDirection attribute
void	SetTextShapingMethod ( const TOptional< ETextShapingMethod... )	See TextShapingMethod attribute
void	SetTextStyle ( const FTextBlockStyle* InTextS... )	See attribute TextStyle
void	SetVirtualKeyboardDismissAction ( TAttribute< EVirtualKeyboardDismiss... )	Set the VirtualKeyboardDismissAction attribute
void	SetWrappingPolicy ( const TAttribute< ETextWrappingPoli... )	Set WrappingPolicy attribute
void	SetWrapTextAt ( const TAttribute< float >& InWrapT... )	See WrapTextAt attribute

Overridden from SWidget

	Name	Description
void	CacheDesiredSize ( float InLayoutScaleMultiplier )	The system calls this method.
FVector2D	ComputeDesiredSize ( float LayoutScaleMultiplier )	Compute the ideal size necessary to display this widget.
bool	ComputeVolatility()	Recomputes the volatility of the widget.
FChildren &#...	GetChildren()	Every widget that has children must implement this method.
bool	IsInteractable()
void	OnArrangeChildren ( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildre... )	Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
FCursorReply	OnCursorQuery ( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent )	The system asks each widget under the mouse to provide a cursor. This event is bubbled.
void	OnFocusLost ( const FFocusEvent& InFocusEvent )	Called when this widget loses focus. This event does not bubble.
FReply	OnFocusReceived ( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent )	KEY INPUT Called when focus is given to this widget. This event does not bubble.
FReply	OnKeyChar ( const FGeometry& MyGeometry, const FCharacterEvent& InCharacter... )	Called after a character is entered while this widget has keyboard focus
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
FReply	OnKeyUp ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is released when this widget has focus
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	Called when a mouse button is double clicked. Override this in derived classes.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
FReply	OnMouseWheel ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Called when the mouse wheel is spun. This event is bubbled.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget with Geometry.

Overridden from ISlateEditableTextWidget

	Name	Description
TSharedPtr< ...	BuildContextMenuContent()	Build the context menu content to use for this widget (if any)
bool	CanInsertCarriageReturn()	Are we currently able to insert a carriage return? (some widgets have modifier keys that need to be pressed)
bool	CanTypeCharacter ( const TCHAR InChar )	Are we able to insert the given character into our text?
void	EnsureActiveTick()	Ensure that we will get a Tick() soon (either due to having active focus, or something having changed progmatically and requiring an update) Does nothing if the active tick timer is already enabled
TSharedRef< ...	GetSlateWidget()	Get the Slate widget this interface is representing (may not be called during destruction)
TSharedPtr< ...	GetSlateWidgetPtr()	Get the Slate widget this interface is representing (may be null during destruction)
EVirtualKeyb...	GetVirtualKeyboardDismissAction()	Get the message action to take when the virtual keyboard is dismissed by the user
FVirtualKeyb...	GetVirtualKeyboardOptions()	Get the options for the virtual keyboard used for this widget
EVirtualKeyb...	GetVirtualKeyboardTrigger()	Get the type of event that will trigger the display of the virtual keyboard
EKeyboardTyp...	GetVirtualKeyboardType()	Get the type of virtual keyboard to use for this widget
bool	IsMultiLineTextEdit()	Is the text edit multi-line aware?
bool	IsTextPassword()	Is the text displaying a password and should be obscured?
bool	IsTextReadOnly()	Is the text currently read-only?
void	OnCursorMoved ( const FTextLocation& InLocation )	Called when the cursor is moved within the text area
void	OnTextChanged ( const FText& InText )	Called when the text has been changed by an edit operation
void	OnTextCommitted ( const FText& InText, const ETextCommit::Type InTextActio... )	Called when the text control has committed its current edit changes
bool	ShouldClearKeyboardFocusOnCommit()	Should we clear the keyboard focus when the user commits text to this widget?
bool	ShouldClearTextSelectionOnFocusLoss()	Should the text clear its selection the widget loses focus?
bool	ShouldJumpCursorToEndWhenFocused()	Should the cursor be jumped to the end of the document when the widget gains focus?
bool	ShouldRevertTextOnEscape()	Should we revert the text back to its original state when the user presses escape?
bool	ShouldSelectAllTextOnCommit()	Should we select all text when the user commits text to this widget?
bool	ShouldSelectAllTextWhenFocused()	Should the text be selected when the widget gains focus?
bool	ShouldSelectWordOnMouseDoubleClick()	Should we select word on mouse double click?
float	UpdateAndClampHorizontalScrollBar ( const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverri... )	Called when the fraction and offset of the horizontal scroll area has been recalculated.
float	UpdateAndClampVerticalScrollBar ( const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverri... )	Called when the fraction and offset of the vertical scroll area has been recalculated.

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
FOnCursorMoved	Called when the cursor is moved within the text area

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss