Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/SSearchBox
| Name | FArguments |
| Type | struct |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SSearchBox.h |
| Include Path | #include "Widgets/Input/SSearchBox.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< SSearchBox >
Inheritance Hierarchy
- FSlateBaseNamedArgs → TSlateBaseNamedArgs → SSearchBox::FArguments
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments() |
Widgets/Input/SSearchBox.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| WidgetArgsType | FArguments | Widgets/Input/SSearchBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetArgsType & DelayChangeNotificationsWhileTyping
(
const TAttribute< bool >& InAttribute |
Whether the SearchBox should delay notifying listeners of text changed events until the user is done typing | Widgets/Input/SSearchBox.h | |
WidgetArgsType & DelayChangeNotificationsWhileTypingSeconds
(
const TAttribute< float >& InAttribute |
If we're delaying change notifications how many seconds should we wait? | Widgets/Input/SSearchBox.h | |
WidgetArgsType & HintText
(
const TAttribute< FText >& InAttribute |
The text displayed in the SearchBox when no text has been entered | Widgets/Input/SSearchBox.h | |
WidgetArgsType & InitialText
(
const TAttribute< FText >& InAttribute |
The text displayed in the SearchBox when it's created | Widgets/Input/SSearchBox.h | |
WidgetArgsType & IsSearching
(
const TAttribute< bool >& InAttribute |
Whether or not an external search is currently running. | Widgets/Input/SSearchBox.h | |
WidgetArgsType & MinDesiredWidth
(
const TAttribute< float >& InAttribute |
Minimum width that a text block should be | Widgets/Input/SSearchBox.h | |
WidgetArgsType & OnKeyDownHandler
(
const FOnKeyDown& InDelegate |
Callback delegate to have first chance handling of the OnKeyDown event | Widgets/Input/SSearchBox.h | |
WidgetArgsType & OnSearch
(
const FOnSearch& InDelegate |
This will add a next and previous button to your search box | Widgets/Input/SSearchBox.h | |
WidgetArgsType & OnSearchGlassClicked
(
const FOnClicked& InDelegate |
Optional callback to allow for special functionality to be invoked when the search glass button is clicked | Widgets/Input/SSearchBox.h | |
WidgetArgsType & OnTextChanged
(
const FOnTextChanged& InDelegate |
Invoked whenever the text changes | Widgets/Input/SSearchBox.h | |
WidgetArgsType & OnTextCommitted
(
const FOnTextCommitted& InDelegate |
Invoked whenever the text is committed (e.g. user presses enter) | Widgets/Input/SSearchBox.h | |
WidgetArgsType & OnVerifyTextChanged
(
const FOnVerifyTextChanged& InDelegate |
Called whenever the text is changed programmatically or interactively by the user | Widgets/Input/SSearchBox.h | |
WidgetArgsType & SearchResultData
(
const TAttribute< TOptional< FSearchResultData > >& InAttribute |
Optional search result data to be shown in the search bar. | Widgets/Input/SSearchBox.h | |
WidgetArgsType & SelectAllTextWhenFocused
(
const TAttribute< bool >& InAttribute |
Whether to select all text when the user clicks to give focus on the widget | Widgets/Input/SSearchBox.h | |
WidgetArgsType & Style
(
const FSearchBoxStyle* InArg |
Style used to draw this search box | Widgets/Input/SSearchBox.h |