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

Light Theme

Dark Theme

FArguments

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateBaseNamedArgs

TSlateBaseNamedArgs

SEditableTextBox::FArguments

References

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

Syntax

struct FArguments : public TSlateBaseNamedArgs< SEditableTextBox >

Constructors

	Name	Description
	FArguments()

Functions

	Name	Description
WidgetArgsTy...	AllowContextMenu ( const TAttribute< bool >& InAttrib... )	Whether the context menu can be opened
WidgetArgsTy...	BackgroundColor ( const TAttribute< FSlateColor >& I... )	The color of the background/border around the editable text (overrides Style)
WidgetArgsTy...	ClearKeyboardFocusOnCommit ( const TAttribute< bool >& InAttrib... )	Whether to clear keyboard focus when pressing enter to commit changes
WidgetArgsTy...	ContextMenuExtender ( const FMenuExtensionDelegate& InDe... )	Menu extender for the right-click context menu
WidgetArgsTy...	ErrorReporting ( TSharedPtr< class IErrorReportingWi... )	Provide a alternative mechanism for error reporting.
WidgetArgsTy...	FocusedForegroundColor ( const TAttribute< FSlateColor >& I... )	Text color and opacity when this box has keyboard focus (overrides Style)
WidgetArgsTy...	Font ( const TAttribute< FSlateFontInfo > ... )	Font color and opacity (overrides Style)
WidgetArgsTy...	ForegroundColor ( const TAttribute< FSlateColor >& I... )	Text color and opacity (overrides Style)
WidgetArgsTy...	HintText ( const TAttribute< FText >& InAttri... )	Hint text that appears when there is no text in the text box
WidgetArgsTy...	IsCaretMovedWhenGainFocus ( const TAttribute< bool >& InAttrib... )	Workaround as we loose focus when the auto completion closes.
WidgetArgsTy...	IsPassword ( const TAttribute< bool >& InAttrib... )	Sets whether this text box is for storing a password
WidgetArgsTy...	IsReadOnly ( const TAttribute< bool >& InAttrib... )	Sets whether this text box can actually be modified interactively by the user
WidgetArgsTy...	Justification ( const TAttribute< ETextJustify::Typ... )	How should the value be justified in the editable text field.
WidgetArgsTy...	MinDesiredWidth ( const TAttribute< float >& InAttri... )	Minimum width that a text block should be
WidgetArgsTy...	OnContextMenuOpening ( const FOnContextMenuOpening& InDel... )	Delegate to call before a context menu is opened.
WidgetArgsTy...	OnKeyCharHandler ( const FOnKeyChar& InDelegate )	Callback delegate to have first chance handling of the OnKeyChar event
WidgetArgsTy...	OnKeyDownHandler ( const FOnKeyDown& InDelegate )	Callback delegate to have first chance handling of the OnKeyDown event
WidgetArgsTy...	OnTextChanged ( const FOnTextChanged& InDelegate )	Called whenever the text is changed programmatically or interactively by the user
WidgetArgsTy...	OnTextCommitted ( const FOnTextCommitted& InDelegate )	Called whenever the text is committed.
WidgetArgsTy...	OnVerifyTextChanged ( const FOnVerifyTextChanged& InDele... )	Called whenever the text is changed programmatically or interactively by the user
WidgetArgsTy...	OverflowPolicy ( TOptional< ETextOverflowPolicy > In... )	Determines what happens to text that is clipped and doesnt fit within the allotted area for this text box
WidgetArgsTy...	Padding ( const TAttribute< FMargin >& InAtt... )	Padding between the box/border and the text widget inside (overrides Style)
WidgetArgsTy...	ReadOnlyForegroundColor ( const TAttribute< FSlateColor >& I... )	Text color and opacity when read-only (overrides Style)
WidgetArgsTy...	RevertTextOnEscape ( const TAttribute< bool >& InAttrib... )	Whether to allow the user to back out of changes when they press the escape key
WidgetArgsTy...	SearchText ( const TAttribute< FText >& InAttri... )	Text to search for (a new search is triggered whenever this text changes)
WidgetArgsTy...	SelectAllTextOnCommit ( const TAttribute< bool >& InAttrib... )	Whether to select all text when pressing enter to commit changes
WidgetArgsTy...	SelectAllTextWhenFocused ( const TAttribute< bool >& InAttrib... )	Whether to select all text when the user clicks to give focus on the widget
WidgetArgsTy...	SelectWordOnMouseDoubleClick ( const TAttribute< bool >& InAttrib... )	Whether to select word on mouse double click on the widget
WidgetArgsTy...	Style ( const FEditableTextBoxStyle* I... )	The styling of the textbox
WidgetArgsTy...	Text ( const TAttribute< FText >& InAttri... )	Sets the text content for this editable text box widget
WidgetArgsTy...	TextFlowDirection ( TOptional< ETextFlowDirection > InA... )	Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)
WidgetArgsTy...	TextShapingMethod ( TOptional< ETextShapingMethod > InA... )	Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)
WidgetArgsTy...	VirtualKeyboardDismissAction ( const TAttribute< EVirtualKeyboardD... )	The message action to take when the virtual keyboard is dismissed by the user
WidgetArgsTy...	VirtualKeyboardOptions ( FVirtualKeyboardOptions InArg )	Additional options for the virtual keyboard summoned by this widget
WidgetArgsTy...	VirtualKeyboardTrigger ( const TAttribute< EVirtualKeyboardT... )	The type of event that will trigger the display of the virtual keyboard
WidgetArgsTy...	VirtualKeyboardType ( const TAttribute< EKeyboardType >&... )	The type of virtual keyboard to use on mobile devices

Typedefs

Name	Description
WidgetArgsType