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 > ISlateEditableTextWidget

Light Theme

Dark Theme

ISlateEditableTextWidget

Interface to allow [FSlateEditableTextLayout](API\Runtime\Slate\Widgets\Text\FSlateEditableTextLayout) to notify its parent SEditableText/SMultiLineEditableText of changes, as well as query some widget specific state

Windows

MacOS

Linux

Inheritance Hierarchy

ISlateEditableTextWidget

	SEditableText
	SMultiLineEditableText

References

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

Syntax

class ISlateEditableTextWidget

Remarks

Interface to allow FSlateEditableTextLayout to notify its parent SEditableText/SMultiLineEditableText of changes, as well as query some widget specific state

Functions

	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.

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

Take our survey

Dismiss