FArguments

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateBaseNamedArgs

TSlateBaseNamedArgs

SMultiLineEditableTextBox::FArguments

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Input/SMultiLineEditableTextBox.h

Include

#include "Widgets/Input/SMultiLineEditableTextBox.h"

Syntax

Constructors

Name Description

Public function

FArguments()

Functions

Name Description

Public function

WidgetArgsTy...

 

AllowContextMenu

(
    const TAttribute< bool >& InAttrib...
)

Whether the context menu can be opened

Public function

WidgetArgsTy...

 

AllowMultiLine

(
    const TAttribute< bool >& InAttrib...
)

Whether to allow multi-line text

Public function

WidgetArgsTy...

 

AlwaysShowScrollbars

(
    bool InArg
)

Should we always show the scrollbars (only affects internally created scroll bars)

Public function

WidgetArgsTy...

 

AutoWrapText

(
    const TAttribute< bool >& InAttrib...
)

Whether to wrap text automatically based on the widget's computed horizontal space.

Public function

WidgetArgsTy...

 

BackgroundColor

(
    const TAttribute< FSlateColor >& I...
)

The color of the background/border around the editable text (overrides Style)

Public function

WidgetArgsTy...

 

ClearKeyboardFocusOnCommit

(
    const TAttribute< bool >& InAttrib...
)

Whether to clear keyboard focus when pressing enter to commit changes

Public function

WidgetArgsTy...

 

ClearTextSelectionOnFocusLoss

(
    const TAttribute< bool >& InAttrib...
)

Whether to clear text selection when focus is lost

Public function

WidgetArgsTy...

 

ContextMenuExtender

(
    const FMenuExtensionDelegate& InDe...
)

Menu extender for the right-click context menu

Public function

WidgetArgsTy...

 

CreateSlateTextLayout

(
    const FCreateSlateTextLayout& InDe...
)

Delegate used to create text layouts for this widget.

Public function

WidgetArgsTy...

 

ErrorReporting

(
    TSharedPtr< class IErrorReportingWi...
)

Provide a alternative mechanism for error reporting.

Public function

WidgetArgsTy...

 

FocusedForegroundColor

(
    const TAttribute< FSlateColor >& I...
)

Text color and opacity when this box has keyboard focus (overrides Style)

Public function

WidgetArgsTy...

 

Font

(
    const TAttribute< FSlateFontInfo > ...
)

Font color and opacity (overrides Style)

Public function

WidgetArgsTy...

 

ForegroundColor

(
    const TAttribute< FSlateColor >& I...
)

Text color and opacity (overrides Style)

Public function

WidgetArgsTy...

 

HintText

(
    const TAttribute< FText >& InAttri...
)

Hint text that appears when there is no text in the text box

Public function

WidgetArgsTy...

 

HScrollBar

(
    TSharedPtr< SScrollBar > InArg
)

The horizontal scroll bar widget, or null to create one internally

Public function

WidgetArgsTy...

 

HScrollBarPadding

(
    const TAttribute< FMargin >& InAtt...
)

Padding around the horizontal scrollbar (overrides Style)

Public function

WidgetArgsTy...

 

IsCaretMovedWhenGainFocus

(
    const TAttribute< bool >& InAttrib...
)

Workaround as we loose focus when the auto completion closes.

Public function

WidgetArgsTy...

 

IsReadOnly

(
    const TAttribute< bool >& InAttrib...
)

Sets whether this text box can actually be modified interactively by the user

Public function

WidgetArgsTy...

 

Justification

(
    const TAttribute< ETextJustify::Typ...
)

How the text should be aligned with the margin.

Public function

WidgetArgsTy...

 

LineHeightPercentage

(
    const TAttribute< float >& InAttri...
)

The amount to scale each lines height by.

Public function

WidgetArgsTy...

 

Margin

(
    const TAttribute< FMargin >& InAtt...
)

The amount of blank space left around the edges of text area.

Public function

WidgetArgsTy...

 

Marshaller

The marshaller used to get/set the raw text to/from the text layout.

Public function

WidgetArgsTy...

 

ModiferKeyForNewLine

(
    EModifierKey::Type InArg
)

The optional modifier key necessary to create a newline when typing into the editor.

Public function

WidgetArgsTy...

 

OnContextMenuOpening

(
    const FOnContextMenuOpening& InDel...
)

Delegate to call before a context menu is opened.

Public function

WidgetArgsTy...

 

OnCursorMoved

(
    const SMultiLineEditableText::FOnCu...
)

Called when the cursor is moved within the text area

Public function

WidgetArgsTy...

 

OnHScrollBarUserScrolled

(
    const FOnUserScrolled& InDelegate
)

Called whenever the horizontal scrollbar is moved by the user

Public function

WidgetArgsTy...

 

OnIsTypedCharValid

(
    const FOnIsTypedCharValid& InDeleg...
)

This is NOT for validating input!

Public function

WidgetArgsTy...

 

OnKeyCharHandler

(
    const FOnKeyChar& InDelegate
)

Callback delegate to have first chance handling of the OnKeyChar event

Public function

WidgetArgsTy...

 

OnKeyDownHandler

(
    const FOnKeyDown& InDelegate
)

Callback delegate to have first chance handling of the OnKeyDown event

Public function

WidgetArgsTy...

 

OnTextChanged

(
    const FOnTextChanged& InDelegate
)

Called whenever the text is changed programmatically or interactively by the user

Public function

WidgetArgsTy...

 

OnTextCommitted

(
    const FOnTextCommitted& InDelegate
)

Called whenever the text is committed.

Public function

WidgetArgsTy...

 

OnVScrollBarUserScrolled

(
    const FOnUserScrolled& InDelegate
)

Called whenever the vertical scrollbar is moved by the user

Public function

WidgetArgsTy...

 

OverflowPolicy

(
    TOptional< ETextOverflowPolicy > In...
)

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

Public function

WidgetArgsTy...

 

Padding

(
    const TAttribute< FMargin >& InAtt...
)

Padding between the box/border and the text widget inside (overrides Style)

Public function

WidgetArgsTy...

 

ReadOnlyForegroundColor

(
    const TAttribute< FSlateColor >& I...
)

Text color and opacity when read-only (overrides Style)

Public function

WidgetArgsTy...

 

RevertTextOnEscape

(
    const TAttribute< bool >& InAttrib...
)

Whether to allow the user to back out of changes when they press the escape key

Public function

WidgetArgsTy...

 

SearchText

(
    const TAttribute< FText >& InAttri...
)

Text to search for (a new search is triggered whenever this text changes)

Public function

WidgetArgsTy...

 

SelectAllTextOnCommit

(
    const TAttribute< bool >& InAttrib...
)

Whether to select all text when pressing enter to commit changes

Public function

WidgetArgsTy...

 

SelectAllTextWhenFocused

(
    const TAttribute< bool >& InAttrib...
)

Whether to select all text when the user clicks to give focus on the widget

Public function

WidgetArgsTy...

 

SelectWordOnMouseDoubleClick

(
    const TAttribute< bool >& InAttrib...
)

Whether to select word on mouse double click on the widget

Public function

WidgetArgsTy...

 

Style

(
    const FEditableTextBoxStyle* I...
)

The styling of the textbox

Public function

WidgetArgsTy...

 

Text

(
    const TAttribute< FText >& InAttri...
)

Sets the text content for this editable text box widget

Public function

WidgetArgsTy...

 

TextFlowDirection

(
    TOptional< ETextFlowDirection > InA...
)

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

Public function

WidgetArgsTy...

 

TextShapingMethod

(
    TOptional< ETextShapingMethod > InA...
)

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

Public function

WidgetArgsTy...

 

TextStyle

(
    const FTextBlockStyle* InArg
)

Pointer to a style of the text block, which dictates the font, color, and shadow options.

Public function

WidgetArgsTy...

 

VirtualKeyboardDismissAction

(
    const TAttribute< EVirtualKeyboardD...
)

The message action to take when the virtual keyboard is dismissed by the user

Public function

WidgetArgsTy...

 

VirtualKeyboardOptions

(
    FVirtualKeyboardOptions InArg
)

Additional options used by the virtual keyboard summoned by this widget

Public function

WidgetArgsTy...

 

VirtualKeyboardTrigger

(
    const TAttribute< EVirtualKeyboardT...
)

The type of event that will trigger the display of the virtual keyboard

Public function

WidgetArgsTy...

 

VScrollBar

(
    TSharedPtr< SScrollBar > InArg
)

The vertical scroll bar widget, or null to create one internally

Public function

WidgetArgsTy...

 

VScrollBarPadding

(
    const TAttribute< FMargin >& InAtt...
)

Padding around the vertical scrollbar (overrides Style)

Public function

WidgetArgsTy...

 

WrappingPolicy

(
    const TAttribute< ETextWrappingPoli...
)

The wrapping policy to use

Public function

WidgetArgsTy...

 

WrapTextAt

(
    const TAttribute< float >& InAttri...
)

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