Navigation
API > API/Runtime > API/Runtime/Slate
A text box that is used for searching. Meant to be as easy to use as possible with as few options as possible.
| Name | SSearchBox |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SSearchBox.h |
| Include Path | #include "Widgets/Input/SSearchBox.h" |
Syntax
class SSearchBox : public SEditableTextBox
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBorder → SEditableTextBox → SSearchBox
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBorder → SEditableTextBox → SSearchBox
Structs
| Name | Remarks |
|---|---|
| FArguments | |
| FSearchResultData | Data for external search results to be shown in the search box. |
Enums
Public
| Name | Remarks |
|---|---|
| SearchDirection | Which direction to go when searching |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnSearch | TBaseDelegate_OneParam< void, SSearchBox::SearchDirection > | Widgets/Input/SSearchBox.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveFont | FSlateFontInfo | Fonts that specify how to render search text when inactive, and active | Widgets/Input/SSearchBox.h | |
| ActiveTimerHandle | TWeakPtr< FActiveTimerHandle > | Handle to the active trigger text changed timer | Widgets/Input/SSearchBox.h | |
| bIsSearching | TAttribute< bool > | Whether or not an external search is currently running. | Widgets/Input/SSearchBox.h | |
| DelayChangeNotificationsWhileTyping | TAttribute< bool > | Whether the SearchBox should delay notifying listeners of text changed events until the user is done typing | Widgets/Input/SSearchBox.h | |
| DelayChangeNotificationsWhileTypingSeconds | TAttribute< float > | If we're delaying change notifications how many seconds should we wait? | Widgets/Input/SSearchBox.h | |
| InactiveFont | FSlateFontInfo | Widgets/Input/SSearchBox.h | ||
| OnSearchDelegate | FOnSearch | Delegate that is invoked when the user does next or previous | Widgets/Input/SSearchBox.h | |
| OnTextChangedDelegate | FOnTextChanged | Delegate that is invoked when the text changes | Widgets/Input/SSearchBox.h | |
| OnTextCommittedDelegate | FOnTextCommitted | Delegate that is invoked when the text is committed | Widgets/Input/SSearchBox.h | |
| SearchResultData | TAttribute< TOptional< FSearchResultData > > | Optional search result data to be shown in the search bar. | Widgets/Input/SSearchBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Widgets/Input/SSearchBox.h | ||
FTextSelection GetSelection() |
Get the current selection | Widgets/Input/SSearchBox.h | |
void SelectText
(
const FTextLocation& InSelectionStart, |
Select a block of text | Widgets/Input/SSearchBox.h |