FArguments

Windows
MacOS
Linux

Inheritance Hierarchy

FSlateBaseNamedArgs

TSlateBaseNamedArgs

SSuggestionTextBox::FArguments

References

Module

Slate

Header

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

Include

#include "Widgets/Input/SSuggestionTextBox.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SSuggestionTextBox >

Constructors

Name Description

Public function

FArguments()

Functions

Name Description

Public function

WidgetArgsTy...

 

BackgroundColor

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

The color of the background/border around the editable text.

Public function

WidgetArgsTy...

 

BackgroundImage

(
    const FSlateBrush* InArg
)

The image of the background/border around the editable text.

Public function

WidgetArgsTy...

 

ClearKeyboardFocusOnCommit

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

Whether to clear keyboard focus when pressing enter to commit changes.

Public function

WidgetArgsTy...

 

ErrorReporting

(
    TSharedPtr< class IErrorReportingWi...
)

Provides an alternative mechanism for error reporting.

Public function

WidgetArgsTy...

 

Font

(
    const TAttribute< FSlateFontInfo > ...
)

Font color and opacity.

Public function

WidgetArgsTy...

 

ForegroundColor

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

Text color and opacity.

Public function

WidgetArgsTy...

 

HintText

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

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

Public function

WidgetArgsTy...

 

IsCaretMovedWhenGainFocus

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

Workaround as we loose focus when the auto completion closes.

Public function

WidgetArgsTy...

 

MinDesiredWidth

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

Minimum width that a text block should be.

Public function

WidgetArgsTy...

 

OnShowingHistory

(
    const FOnShowingHistory& InDelegat...
)

Called before the history list is shown.

Public function

WidgetArgsTy...

 

OnShowingSuggestions

(
    const FOnShowingSuggestions& InDel...
)

Called before the suggestion list is shown.

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 when the text has been committed.

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...

 

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...

 

SuggestionListMaxHeight

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

The maximum height of the suggestion list.

Public function

WidgetArgsTy...

 

SuggestionTextStyle

(
    const FTextBlockStyle* InArg
)

The styling of the suggestion text.

Public function

WidgetArgsTy...

 

Text

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

Sets the text content for this editable text box widget.

Public function

WidgetArgsTy...

 

TextStyle

(
    const FEditableTextBoxStyle* I...
)

The styling of the text box.

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