1. Epic GamesDeveloper
  3. FArguments

FArguments

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/SMultiLineEditableText

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

Syntax

struct FArguments : public TSlateBaseNamedArgs< SMultiLineEditableText >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FArguments()

   Widgets/Text/SMultiLineEditableText.h  

Typedefs

Name Type Remarks Include Path
WidgetArgsType FArguments   Widgets/Text/SMultiLineEditableText.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Whether to prevent the context menu from being displayed Widgets/Text/SMultiLineEditableText.h  

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

 Whether to allow multi-line text Widgets/Text/SMultiLineEditableText.h  

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

 The amount to scale each lines height by. Widgets/Text/SMultiLineEditableText.h  

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

 Whether to wrap text automatically based on the widget's computed horizontal space. Widgets/Text/SMultiLineEditableText.h  

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

 Whether to clear keyboard focus when pressing enter to commit changes Widgets/Text/SMultiLineEditableText.h  

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

 Whether to clear text selection when focus is lost Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & ContextMenuExtender ( const FMenuExtensionDelegate& InDelegate
)

 Menu extender for the right-click context menu Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & CreateSlateTextLayout ( const FCreateSlateTextLayout& InDelegate
)

 Delegate used to create text layouts for this widget. Widgets/Text/SMultiLineEditableText.h  

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

 Font color and opacity (overrides Style) Widgets/Text/SMultiLineEditableText.h  

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

 Hint text that appears when there is no text in the text box Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & HScrollBar ( TSharedPtr< SScrollBar > InArg
)

 The horizontal scroll bar widget Widgets/Text/SMultiLineEditableText.h  

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

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

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

 How the text should be aligned with the margin. Widgets/Text/SMultiLineEditableText.h  

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

 The amount to scale each lines height by. Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & Margin ( const TAttribute< FMargin >& InAttribute
)

 The amount of blank space left around the edges of text area. Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & Marshaller ( TSharedPtr< ITextLayoutMarshaller > InArg
)

 The marshaller used to get/set the raw text to/from the text layout. Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & ModiferKeyForNewLine ( EModifierKey::Type InArg
)

 The optional modifier key necessary to create a newline when typing into the editor. Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnBeginTextEdit ( const FOnBeginTextEdit& InDelegate
)

 Callback when the text starts to be edited Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnContextMenuOpening ( const FOnContextMenuOpening& InDelegate
)

 Delegate to call before a context menu is opened. Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnCursorMoved ( const FOnCursorMoved& InDelegate
)

 Called when the cursor is moved within the text area Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnHScrollBarUserScrolled ( const FOnUserScrolled& InDelegate
)

 Called whenever the horizontal scrollbar is moved by the user Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnIsTypedCharValid ( const FOnIsTypedCharValid& InDelegate
)

 This is NOT for validating input! Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnKeyCharHandler ( const FOnKeyChar& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyChar event Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnKeyDownHandler ( const FOnKeyDown& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyDown event Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnTextChanged ( const FOnTextChanged& InDelegate
)

 Called whenever the text is changed programmatically or interactively by the user Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnTextCommitted ( const FOnTextCommitted& InDelegate
)

 Called whenever the text is committed. Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OnVScrollBarUserScrolled ( const FOnUserScrolled& InDelegate
)

 Called whenever the vertical scrollbar is moved by the user Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & OverflowPolicy ( TOptional< ETextOverflowPolicy > InArg
)

 Determines what happens to text that is clipped and doesnt fit within the clip rect for this widget Widgets/Text/SMultiLineEditableText.h  

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

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

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

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

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

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

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

 Whether to select word on mouse double click on the widget Widgets/Text/SMultiLineEditableText.h  

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

 The initial text that will appear in the widget. Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & TextFlowDirection ( TOptional< ETextFlowDirection > InArg
)

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

WidgetArgsType & TextShapingMethod ( TOptional< ETextShapingMethod > InArg
)

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

WidgetArgsType & TextStyle ( const FTextBlockStyle* InArg
)

 Pointer to a style of the text block, which dictates the font, color, and shadow options. Widgets/Text/SMultiLineEditableText.h  

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

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

WidgetArgsType & VirtualKeyboardOptions ( FVirtualKeyboardOptions InArg
)

 Additional options for the virtual keyboard used by this widget Widgets/Text/SMultiLineEditableText.h  

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

 The type of event that will trigger the display of the virtual keyboard Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & VScrollBar ( TSharedPtr< SScrollBar > InArg
)

 The vertical scroll bar widget Widgets/Text/SMultiLineEditableText.h  

WidgetArgsType & WrappingPolicy ( const TAttribute< ETextWrappingPolicy >& InAttribute
)

 The wrapping policy to use Widgets/Text/SMultiLineEditableText.h  

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

 Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs. Widgets/Text/SMultiLineEditableText.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page