1. Epic GamesDeveloper
  3. FArguments

FArguments

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input > API/Runtime/Slate/Widgets/Input/SMultiLineEditableTextBox

Inheritance Hierarchy

References

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

Syntax

struct FArguments : public TSlateBaseNamedArgs< SMultiLineEditableTextBox >

Variables

  Type Name Description
Public variable const FTextBlockStyle * _TextStyle Pointer to a style of the text block, which dictates the font, color, and shadow options.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function WidgetArgsType &

AllowContextMenu ( const TAttribute< bool >& InAttribute
)

 Whether the context menu can be opened
Public function WidgetArgsType &

AllowMultiLine ( const TAttribute< bool >& InAttribute
)

 Whether to allow multi-line text
Public function WidgetArgsType &

AlwaysShowScrollbars ( bool InArg
)

 Should we always show the scrollbars (only affects internally created scroll bars)
Public function WidgetArgsType &

AutoWrapText ( const TAttribute< bool >& InAttribute
)

 Whether to wrap text automatically based on the widget's computed horizontal space.
Public function WidgetArgsType &

BackgroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 The color of the background/border around the editable text (overrides Style)
Public function WidgetArgsType &

ClearKeyboardFocusOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to clear keyboard focus when pressing enter to commit changes
Public function WidgetArgsType &

ClearTextSelectionOnFocusLoss ( const TAttribute< bool >& InAttribute
)

 Whether to clear text selection when focus is lost
Public function WidgetArgsType &

ContextMenuExtender ( const FMenuExtensionDelegate& InDelegate
)

 Menu extender for the right-click context menu
Public function WidgetArgsType &

CreateSlateTextLayout ( const FCreateSlateTextLayout& InDelegate
)

 Delegate used to create text layouts for this widget.
Public function WidgetArgsType & Provide a alternative mechanism for error reporting.
Public function WidgetArgsType &

FocusedForegroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 Text color and opacity when this box has keyboard focus (overrides Style)
Public function WidgetArgsType &

Font ( const TAttribute< FSlateFontInfo >& InAttribute
)

 Font color and opacity (overrides Style)
Public function WidgetArgsType &

ForegroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 Text color and opacity (overrides Style)
Public function WidgetArgsType &

HintText ( const TAttribute< FText >& InAttribute
)

 Hint text that appears when there is no text in the text box
Public function WidgetArgsType & The horizontal scroll bar widget, or null to create one internally
Public function WidgetArgsType &

HScrollBarPadding ( const TAttribute< FMargin >& InAttribute
)

 Padding around the horizontal scrollbar (overrides Style)
Public function WidgetArgsType &

IsCaretMovedWhenGainFocus ( const TAttribute< bool >& InAttribute
)

 Workaround as we loose focus when the auto completion closes.
Public function WidgetArgsType &

IsReadOnly ( const TAttribute< bool >& InAttribute
)

 Sets whether this text box can actually be modified interactively by the user
Public function WidgetArgsType &

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

 How the text should be aligned with the margin.
Public function WidgetArgsType &

LineHeightPercentage ( const TAttribute< float >& InAttribute
)

 The amount to scale each lines height by.
Public function WidgetArgsType &

Margin ( const TAttribute< FMargin >& InAttribute
)

 The amount of blank space left around the edges of text area.
Public function WidgetArgsType & The marshaller used to get/set the raw text to/from the text layout.
Public function WidgetArgsType & The optional modifier key necessary to create a newline when typing into the editor.
Public function WidgetArgsType &

OnContextMenuOpening ( const FOnContextMenuOpening& InDelegate
)

 Delegate to call before a context menu is opened.
Public function WidgetArgsType & Called when the cursor is moved within the text area
Public function WidgetArgsType &

OnHScrollBarUserScrolled ( const FOnUserScrolled& InDelegate
)

 Called whenever the horizontal scrollbar is moved by the user
Public function WidgetArgsType &

OnIsTypedCharValid ( const FOnIsTypedCharValid& InDelegate
)

 This is NOT for validating input!
Public function WidgetArgsType &

OnKeyCharHandler ( const FOnKeyChar& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyChar event
Public function WidgetArgsType &

OnKeyDownHandler ( const FOnKeyDown& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyDown event
Public function WidgetArgsType &

OnTextChanged ( const FOnTextChanged& InDelegate
)

 Called whenever the text is changed programmatically or interactively by the user
Public function WidgetArgsType &

OnTextCommitted ( const FOnTextCommitted& InDelegate
)

 Called whenever the text is committed.
Public function WidgetArgsType &

OnVerifyTextChanged ( const FOnVerifyTextChanged& InDelegate
)

 Called whenever the text is changed programmatically or interactively by the user
Public function WidgetArgsType &

OnVScrollBarUserScrolled ( const FOnUserScrolled& InDelegate
)

 Called whenever the vertical scrollbar is moved by the user
Public function WidgetArgsType &

OverflowPolicy ( TOptional< ETextOverflowPolicy > InArg
)

 Determines what happens to text that is clipped and doesn't fit within the allotted area for this widget
Public function WidgetArgsType &

Padding ( const TAttribute< FMargin >& InAttribute
)

 Padding between the box/border and the text widget inside (overrides Style)
Public function WidgetArgsType &

ReadOnlyForegroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 Text color and opacity when read-only (overrides Style)
Public function WidgetArgsType &

RevertTextOnEscape ( const TAttribute< bool >& InAttribute
)

 Whether to allow the user to back out of changes when they press the escape key
Public function WidgetArgsType &

SearchText ( const TAttribute< FText >& InAttribute
)

 Text to search for (a new search is triggered whenever this text changes)
Public function WidgetArgsType &

SelectAllTextOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when pressing enter to commit changes
Public function WidgetArgsType &

SelectAllTextWhenFocused ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when the user clicks to give focus on the widget
Public function WidgetArgsType &

SelectWordOnMouseDoubleClick ( const TAttribute< bool >& InAttribute
)

 Whether to select word on mouse double click on the widget
Public function WidgetArgsType &

Style ( const FEditableTextBoxStyle* InArg
)

 The styling of the textbox
Public function WidgetArgsType &

Text ( const TAttribute< FText >& InAttribute
)

 Sets the text content for this editable text box widget
Public function WidgetArgsType &

TextFlowDirection ( TOptional< ETextFlowDirection > InArg
)

 Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)
Public function WidgetArgsType &

TextShapingMethod ( TOptional< ETextShapingMethod > InArg
)

 Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)
Public function WidgetArgsType &

TextStyle ( const USlateWidgetStyleAsset*const InSlateStyleAsset
)

  
Public function WidgetArgsType &

TextStyle ( const TWeakObjectPtr< const class USlateWidgetStyleAsset >& InSlateStyleAsset
)

  
Public function WidgetArgsType &

TextStyle ( const ISlateStyle* InSlateStyle,
const FName& StyleName,
const ANSICHAR* Specifier
)

  
Public function WidgetArgsType &

TextStyle ( const ISlateStyle& InSlateStyle,
const FName& StyleName,
const ANSICHAR* Specifier
)

  
Public function WidgetArgsType &

TextStyle ( const TWeakObjectPtr< const class ISlateStyle >& InSlateStyle,
const FName& StyleName,
const ANSICHAR* Specifier
)

  
Public function WidgetArgsType &

TextStyle ( const TSharedPtr< const class ISlateStyle >& InSlateStyle,
const FName& StyleName,
const ANSICHAR* Specifier
)

  
Public function WidgetArgsType &

VirtualKeyboardDismissAction ( const TAttribute< EVirtualKeyboardDismissAction >& InAttribute
)

 The message action to take when the virtual keyboard is dismissed by the user
Public function WidgetArgsType & Additional options used by the virtual keyboard summoned by this widget
Public function WidgetArgsType &

VirtualKeyboardTrigger ( const TAttribute< EVirtualKeyboardTrigger >& InAttribute
)

 The type of event that will trigger the display of the virtual keyboard
Public function WidgetArgsType & The vertical scroll bar widget, or null to create one internally
Public function WidgetArgsType &

VScrollBarPadding ( const TAttribute< FMargin >& InAttribute
)

 Padding around the vertical scrollbar (overrides Style)
Public function WidgetArgsType &

WrappingPolicy ( const TAttribute< ETextWrappingPolicy >& InAttribute
)

 The wrapping policy to use
Public function 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.

Typedefs

Name Description
WidgetArgsType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page