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 > Input > SEditableTextBox

Light Theme

Dark Theme

SEditableTextBox

Editable text box widget

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBorder

SEditableTextBox

SSearchBox

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Include	#include "Widgets/Input/SEditableTextBox.h"

Syntax

class SEditableTextBox : public SBorder

Remarks

Editable text box widget

Variables

	Name	Description
TAttribute< FSl...	BackgroundColorOverride	Background color (overrides style)
TSharedPtr< SHo...	Box	Allows for inserting additional widgets that extend the functionality of the text box
TSharedPtr< SEd...	EditableText	Editable text widget
TSharedPtr< cla...	ErrorReporting	SomeWidget reporting
TAttribute< FSl...	FocusedForegroundColorOverride	Focused foreground color (overrides style)
TAttribute< FSl...	FontOverride	Font (overrides style)
TAttribute< FSl...	ForegroundColorOverride	Foreground color (overrides style)
FOnTextChanged	OnTextChanged	Called when the text is changed interactively
FOnTextCommitte...	OnTextCommitted	Called when the user commits their change to the editable text control
FOnVerifyTextCh...	OnVerifyTextChanged	Callback to verify text when changed. Will return an error message to de problems.
TSharedPtr< SBo...	PaddingBox	Box widget that adds padding around the editable text
TAttribute< FMa...	PaddingOverride	Padding (overrides style)
TAttribute< FSl...	ReadOnlyForegroundColorOverride	Read-only foreground color (overrides style)
const FEditable...	Style

Constructors

	Name	Description
	SEditableTextBox()

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	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 )	Construct this widget
FText	GetSearchText()	Get the text that is currently being searched for (if any)
FText	GetSelectedText()	Get the currently selected text
FText	GetText()	Returns the text string
void	GoTo ( const ETextLocation NewLocation )	Move the cursor to the specified location
void	GoTo ( const FTextLocation& NewLocation )	Move the cursor to the given location in the document
bool	HasError()
bool	IsPassword()
bool	IsReadOnly()
void	OnEditableTextChanged ( const FText& InText )	Callback for the editable text's OnTextChanged event
void	OnEditableTextCommitted ( const FText& InText, ETextCommit::Type InCommitType )	Callback when the editable text is committed.
void	ScrollTo ( const ETextLocation NewLocation )	Scroll to the given location in the document (without moving the cursor)
void	ScrollTo ( const FTextLocation& NewLocation )	Scroll to the given location in the document (without moving the cursor)
void	SelectAllText()	Select all the text in the document
void	SetAllowContextMenu ( TAttribute< bool > InAllowContextMe... )	See the AllowContextMenu attribute
void	SetClearKeyboardFocusOnCommit ( const TAttribute< bool >& InClearK... )	Sets whether to clear keyboard focus when pressing enter to commit changes
void	SetError ( const FString& InError )	If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter.
void	SetError ( const FText& InError )	If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter.
void	SetFocusedForegroundColor ( const TAttribute< FSlateColor >& I... )	Sets the text color and opacity when this box has keyboard focus(overrides Style)
void	SetFont ( const TAttribute< FSlateFontInfo > ... )	Sets the font used to draw the text
void	SetHintText ( const TAttribute< FText >& InHintT... )	See the HintText attribute
void	SetIsCaretMovedWhenGainFocus ( const TAttribute< bool >& InIsCare... )	Workaround as we loose focus when the auto completion closes.
void	SetIsPassword ( TAttribute< bool > InIsPassword )	See the IsPassword attribute
void	SetIsReadOnly ( TAttribute< bool > InIsReadOnly )	See the IsReadOnly attribute
void	SetJustification ( const TAttribute< ETextJustify::Typ... )	See Justification attribute
void	SetMinimumDesiredWidth ( const TAttribute< float >& InMinim... )	Sets the minimum width that a text box should be.
void	SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler )	Sets the OnKeyCharHandler to provide first chance handling of the SEditableText's OnKeyChar event
void	SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler )	Sets the OnKeyDownHandler to provide first chance handling of the SEditableText's OnKeyDown event
void	SetOverflowPolicy ( TOptional< ETextOverflowPolicy > In... )	Sets the overflow policy for this text block
void	SetReadOnlyForegroundColor ( const TAttribute< FSlateColor >& I... )	Sets the text color and opacity when read-only (overrides Style)
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	SetSelectAllTextOnCommit ( const TAttribute< bool >& InSelect... )	Sets whether to select all text when pressing enter to commit changes
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 select word on mouse double click
void	SetStyle ( const FEditableTextBoxStyle* I... )	See attribute Style
void	SetText ( const TAttribute< FText >& InNewTe... )	Sets the text string currently being edited
void	SetTextBoxBackgroundColor ( const TAttribute< FSlateColor >& I... )	Sets the color of the background/border around the editable text (overrides Style)
void	SetTextBoxForegroundColor ( const TAttribute< FSlateColor >& I... )	Sets the text color and opacity (overrides Style)
void	SetTextFlowDirection ( const TOptional< ETextFlowDirection... )	See TextFlowDirection attribute
void	SetTextShapingMethod ( const TOptional< ETextShapingMethod... )	See TextShapingMethod attribute
void	SetVirtualKeyboardDismissAction ( TAttribute< EVirtualKeyboardDismiss... )	Set the VirtualKeyboardDismissAction attribute

Overridden from SWidget

	Name	Description
TSharedRef< ...	CreateAccessibleWidget()
TOptional< F...	GetDefaultAccessibleText ( EAccessibleType AccessibleType )	Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.
bool	HasKeyboardFocus()	Checks to see if this widget currently has the keyboard focus
FReply	OnFocusReceived ( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent )	KEY INPUT Called when focus is given to this widget. This event does not bubble.
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)
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

	Name	Description
	FArguments