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

Light Theme

Dark Theme

FArguments

Windows

MacOS

Linux

Inheritance Hierarchy

TSlateBaseNamedArgs

SEditableText::FArguments

References

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

Syntax

struct FArguments : public TSlateBaseNamedArgs< SEditableText >

Constructors

	Name	Description
	FArguments()

Functions

	Name	Description
WidgetArgsTy...	AllowContextMenu ( const TAttribute< bool >& InAttrib... )	Whether the context menu can be opened
WidgetArgsTy...	BackgroundImageComposing ( const TAttribute< const FSlateBrush... )	Background image for the composing text (overrides Style)
WidgetArgsTy...	BackgroundImageSelected ( const TAttribute< const FSlateBrush... )	Background image for the selected text (overrides Style)
WidgetArgsTy...	CaretImage ( const TAttribute< const FSlateBrush... )	Image brush used for the caret (overrides Style)
WidgetArgsTy...	ClearKeyboardFocusOnCommit ( const TAttribute< bool >& InAttrib... )	Whether to clear keyboard focus when pressing enter to commit changes
WidgetArgsTy...	ColorAndOpacity ( const TAttribute< FSlateColor >& I... )	Text color and opacity (overrides Style)
WidgetArgsTy...	ContextMenuExtender ( const FMenuExtensionDelegate& InDe... )	Menu extender for the right-click context menu
WidgetArgsTy...	Font ( const TAttribute< FSlateFontInfo > ... )	Sets the font used to draw the text (overrides Style)
WidgetArgsTy...	HintText ( const TAttribute< FText >& InAttri... )	The text that appears when there is nothing typed into the search 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...	OnIsTypedCharValid ( const FOnIsTypedCharValid& InDeleg... )	This is NOT for validating input!
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...	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...	Style ( const FEditableTextStyle* InAr... )	The style of the text block, which dictates the font, color
WidgetArgsTy...	Text ( const TAttribute< FText >& InAttri... )	Sets the text content for this editable text 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 used by 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

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

Take our survey

Dismiss