Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/SSuggestionTextBox
| Name | FArguments |
| Type | struct |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SSuggestionTextBox.h |
| Include Path | #include "Widgets/Input/SSuggestionTextBox.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< SSuggestionTextBox >
Inheritance Hierarchy
- FSlateBaseNamedArgs → TSlateBaseNamedArgs → SSuggestionTextBox::FArguments
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments() |
Widgets/Input/SSuggestionTextBox.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| WidgetArgsType | FArguments | Widgets/Input/SSuggestionTextBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetArgsType & BackgroundColor
(
const TAttribute< FSlateColor >& InAttribute |
The color of the background/border around the editable text. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & BackgroundImage
(
const FSlateBrush* InArg |
The image of the background/border around the editable text. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & ClearKeyboardFocusOnCommit
(
const TAttribute< bool >& InAttribute |
Whether to clear keyboard focus when pressing enter to commit changes. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & CommitOnSuggestionSelected
(
const TAttribute< bool >& InAttribute |
Whether to commit text that was selected from the suggestions list. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & ErrorReporting
(
TSharedPtr< class IErrorReportingWidget > InArg |
Provides an alternative mechanism for error reporting. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & Font
(
const TAttribute< FSlateFontInfo >& InAttribute |
Font color and opacity. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & ForegroundColor
(
const TAttribute< FSlateColor >& InAttribute |
Text color and opacity. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & HintText
(
const TAttribute< FText >& InAttribute |
Hint text that appears when there is no text in the text box. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & IsCaretMovedWhenGainFocus
(
const TAttribute< bool >& InAttribute |
Workaround as we loose focus when the auto completion closes. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & MinDesiredWidth
(
const TAttribute< float >& InAttribute |
Minimum width that a text block should be. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & OnShowingHistory
(
const FOnShowingHistory& InDelegate |
Called before the history list is shown. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & OnShowingSuggestions
(
const FOnShowingSuggestions& InDelegate |
Called before the suggestion list is shown. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & OnTextChanged
(
const FOnTextChanged& InDelegate |
Called whenever the text is changed programmatically or interactively by the user. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & OnTextCommitted
(
const FOnTextCommitted& InDelegate |
Called when the text has been committed. | Widgets/Input/SSuggestionTextBox.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/SSuggestionTextBox.h | |
WidgetArgsType & SelectAllTextOnCommit
(
const TAttribute< bool >& InAttribute |
Whether to select all text when pressing enter to commit changes. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & SelectAllTextWhenFocused
(
const TAttribute< bool >& InAttribute |
Whether to select all text when the user clicks to give focus on the widget. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & SuggestionListMaxHeight
(
const TAttribute< float >& InAttribute |
The maximum height of the suggestion list. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & SuggestionTextStyle
(
const FTextBlockStyle* InArg |
The styling of the suggestion text. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & Text
(
const TAttribute< FText >& InAttribute |
Sets the text content for this editable text box widget. | Widgets/Input/SSuggestionTextBox.h | |
WidgetArgsType & TextStyle
(
const FEditableTextBoxStyle* InArg |
The styling of the text box. | Widgets/Input/SSuggestionTextBox.h |