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

Light Theme

Dark Theme

SInlineEditableTextBlock

Slate's InlineEditableTextBlock's are double selectable to go from a [STextBlock](API\Runtime\Slate\Widgets\Text\STextBlock) to become [SEditableTextBox](API\Runtime\Slate\Widgets\Input\SEditableTextBox).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SInlineEditableTextBlock

References

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

Syntax

class SInlineEditableTextBlock : public SCompoundWidget

Remarks

Slate's InlineEditableTextBlock's are double selectable to go from a STextBlock to become SEditableTextBox.

Variables

	Name	Description
uint8: 1	bIsMultiLine	Attribute to look up if the widget is multiline
TAttribute< boo...	bIsReadOnly	Attribute to look up if the widget is read-only
float	DoubleSelectDelay	When selection of widget is managed by another widget, this delays the "double select" from occurring immediately, offering a chance for double clicking to take action.
TSharedPtr< SHo...	HorizontalBox	Main horizontal box, used to dynamically add and remove the editable slot.
FIsSelected	IsSelected	Delegate to execute to check the status of if the widget is selected or not Only needs to be hooked up if an external widget is managing selection, such as a SListView or STreeView.
TSharedPtr< SMu...	MultiLineTextBox	The widget used when in editing mode
FOnBeginTextEdi...	OnBeginTextEditDelegate	Delegate to execute when the text starts to be edited
FSimpleDelegate	OnEnterEditingMode
FSimpleDelegate	OnExitEditingMode
FOnTextCommitte...	OnTextCommittedDelegate	Delegate to execute when editing mode text is committed.
FOnVerifyTextCh...	OnVerifyTextChanged	Callback to verify text when changed. Will return an error message to de problems.
TAttribute< FTe...	Text	Attribute for the text to use for the widget
TSharedPtr< STe...	TextBlock	The widget used when in label mode
TSharedPtr< SEd...	TextBox	The widget used when in editing mode
TWeakPtr< SWidg...	WidgetToFocus	Widget to focus when we finish editing

Destructors

	Name	Description
	~SInlineEditableTextBlock()

Functions

	Name	Description
void	CancelEditMode()	Cancels the edit mode and switches back to label mode
void	Construct ( const FArguments& InArgs )	Construct this widget. Called by the SNew()Slate macro.
void	EnterEditingMode()	Switches the widget to editing mode
void	ExitEditingMode()	Switches the widget to label mode.
bool	IsInEditMode()	Checks if the widget is in edit mode
void	OnTextBoxCommitted ( const FText& InText, ETextCommit::Type InCommitType )	Callback when the text box is committed, switches back to label mode.
void	OnTextChanged ( const FText& InText )	Callback for the text box's OnTextChanged event
void	SetOverflowPolicy ( TOptional< ETextOverflowPolicy > In... )	Sets the overflow policy for this text block
void	SetReadOnly ( bool bInIsReadOnly )
void	SetText ( const TAttribute< FText >& InText )
void	SetText ( const FString& InText )
void	SetWrapTextAt ( const TAttribute< float >& InWrapT... )	Sets the wrap text at attribute. See WrapTextAt attribute

Overridden from SWidget

	Name	Description
FReply	OnDragOver ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	Called during drag and drop when the the mouse is being dragged over a widget.
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	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.
bool	SupportsKeyboardFocus()	See SWidget::SupportsKeyboardFocus().

Classes

	Name	Description
	FArguments