1. Epic GamesDeveloper
  3. FArguments

FArguments

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/SEditableText

   
Name FArguments
Type struct
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Include Path #include "Widgets/Input/SEditableText.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SEditableText >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FArguments()

   Widgets/Input/SEditableText.h  

Typedefs

Name Type Remarks Include Path
WidgetArgsType FArguments   Widgets/Input/SEditableText.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

WidgetArgsType & AllowContextMenu ( const TAttribute< bool >& InAttribute
)

 Whether the context menu can be opened Widgets/Input/SEditableText.h  

WidgetArgsType & BackgroundImageComposing ( const TAttribute< const FSlateBrush* >& InAttribute
)

 Background image for the composing text (overrides Style) Widgets/Input/SEditableText.h  

WidgetArgsType & BackgroundImageSelected ( const TAttribute< const FSlateBrush* >& InAttribute
)

 Background image for the selected text (overrides Style) Widgets/Input/SEditableText.h  

WidgetArgsType & CaretImage ( const TAttribute< const FSlateBrush* >& InAttribute
)

 Image brush used for the caret (overrides Style) Widgets/Input/SEditableText.h  

WidgetArgsType & ClearKeyboardFocusOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to clear keyboard focus when pressing enter to commit changes Widgets/Input/SEditableText.h  

WidgetArgsType & ColorAndOpacity ( const TAttribute< FSlateColor >& InAttribute
)

 Text color and opacity (overrides Style) Widgets/Input/SEditableText.h  

WidgetArgsType & ContextMenuExtender ( const FMenuExtensionDelegate& InDelegate
)

 Menu extender for the right-click context menu Widgets/Input/SEditableText.h  

WidgetArgsType & EnableIntegratedKeyboard ( const TAttribute< bool >& InAttribute
)

 Whether the IntegratedKeyboard is enabled Widgets/Input/SEditableText.h  

WidgetArgsType & Font ( const TAttribute< FSlateFontInfo >& InAttribute
)

 Sets the font used to draw the text (overrides Style) Widgets/Input/SEditableText.h  

WidgetArgsType & HintText ( const TAttribute< FText >& InAttribute
)

 The text that appears when there is nothing typed into the search box Widgets/Input/SEditableText.h  

WidgetArgsType & IsCaretMovedWhenGainFocus ( const TAttribute< bool >& InAttribute
)

 Workaround as we loose focus when the auto completion closes. Widgets/Input/SEditableText.h  

WidgetArgsType & IsPassword ( const TAttribute< bool >& InAttribute
)

 Sets whether this text box is for storing a password Widgets/Input/SEditableText.h  

WidgetArgsType & IsReadOnly ( const TAttribute< bool >& InAttribute
)

 Sets whether this text box can actually be modified interactively by the user Widgets/Input/SEditableText.h  

WidgetArgsType & Justification ( const TAttribute< ETextJustify::Type >& InAttribute
)

 How should the value be justified in the editable text field. Widgets/Input/SEditableText.h  

WidgetArgsType & MinDesiredWidth ( const TAttribute< float >& InAttribute
)

 Minimum width that a text block should be Widgets/Input/SEditableText.h  

WidgetArgsType & OnBeginTextEdit ( const FOnBeginTextEdit& InDelegate
)

 Callback when the text starts to be edited Widgets/Input/SEditableText.h  

WidgetArgsType & OnContextMenuOpening ( const FOnContextMenuOpening& InDelegate
)

 Delegate to call before a context menu is opened. Widgets/Input/SEditableText.h  

WidgetArgsType & OnIsTypedCharValid ( const FOnIsTypedCharValid& InDelegate
)

 This is NOT for validating input! Widgets/Input/SEditableText.h  

WidgetArgsType & OnKeyCharHandler ( const FOnKeyChar& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyChar event Widgets/Input/SEditableText.h  

WidgetArgsType & OnKeyDownHandler ( const FOnKeyDown& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyDown event Widgets/Input/SEditableText.h  

WidgetArgsType & OnTextChanged ( const FOnTextChanged& InDelegate
)

 Called whenever the text is changed programmatically or interactively by the user Widgets/Input/SEditableText.h  

WidgetArgsType & OnTextCommitted ( const FOnTextCommitted& InDelegate
)

 Called whenever the text is committed. Widgets/Input/SEditableText.h  

WidgetArgsType & OverflowPolicy ( TOptional< ETextOverflowPolicy > InArg
)

 Determines what happens to text that is clipped and doesnt fit within the allotted area for this widget Widgets/Input/SEditableText.h  

WidgetArgsType & RevertTextOnEscape ( const TAttribute< bool >& InAttribute
)

 Whether to allow the user to back out of changes when they press the escape key Widgets/Input/SEditableText.h  

WidgetArgsType & SearchText ( const TAttribute< FText >& InAttribute
)

 Text to search for (a new search is triggered whenever this text changes) Widgets/Input/SEditableText.h  

WidgetArgsType & SelectAllTextOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when pressing enter to commit changes Widgets/Input/SEditableText.h  

WidgetArgsType & SelectAllTextWhenFocused ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when the user clicks to give focus on the widget Widgets/Input/SEditableText.h  

WidgetArgsType & SelectWordOnMouseDoubleClick ( const TAttribute< bool >& InAttribute
)

 Whether to select word on mouse double click on the widget Widgets/Input/SEditableText.h  

WidgetArgsType & Style ( const FEditableTextStyle* InArg
)

 The style of the text block, which dictates the font, color Widgets/Input/SEditableText.h  

WidgetArgsType & Text ( const TAttribute< FText >& InAttribute
)

 Sets the text content for this editable text widget Widgets/Input/SEditableText.h  

WidgetArgsType & TextFlowDirection ( TOptional< ETextFlowDirection > InArg
)

 Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection) Widgets/Input/SEditableText.h  

WidgetArgsType & TextShapingMethod ( TOptional< ETextShapingMethod > InArg
)

 Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod) Widgets/Input/SEditableText.h  

WidgetArgsType & VirtualKeyboardDismissAction ( const TAttribute< EVirtualKeyboardDismissAction >& InAttribute
)

 The message action to take when the virtual keyboard is dismissed by the user Widgets/Input/SEditableText.h  

WidgetArgsType & VirtualKeyboardOptions ( FVirtualKeyboardOptions InArg
)

 Additional options used by the virtual keyboard summoned by this widget Widgets/Input/SEditableText.h  

WidgetArgsType & VirtualKeyboardTrigger ( const TAttribute< EVirtualKeyboardTrigger >& InAttribute
)

 The type of event that will trigger the display of the virtual keyboard Widgets/Input/SEditableText.h  

WidgetArgsType & VirtualKeyboardType ( const TAttribute< EKeyboardType >& InAttribute
)

 The type of virtual keyboard to use on mobile devices Widgets/Input/SEditableText.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page