Navigation
API > API/Editor > API/Editor/EditorWidgets
A widget to provide a search box with a filtered dropdown menu. Also provides the functionality to show search history optionally, and a button/delegate to save a search via SetOnSaveSearchHandler
| Name | SAssetSearchBox |
| Type | class |
| Header File | /Engine/Source/Editor/EditorWidgets/Public/SAssetSearchBox.h |
| Include Path | #include "SAssetSearchBox.h" |
Syntax
class SAssetSearchBox : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SAssetSearchBox
- FSlateControlledConstruction → SWidget → SCompoundWidget → SAssetSearchBox
Structs
| Name | Remarks |
|---|---|
| FArguments | |
| FSuggestionListEntry |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bMustMatchPossibleSuggestions | bool | Determines whether or not the committed text should match a suggestion | SAssetSearchBox.h | |
| InputText | TSharedPtr< SFilterSearchBox > | The editable text field | SAssetSearchBox.h | |
| OnAssetSearchBoxSuggestionChosen | FOnAssetSearchBoxSuggestionChosen | Delegate when a suggestion entry is chosen during an asset search, to allow custom compositing behavior of the suggestion into the search text | SAssetSearchBox.h | |
| OnAssetSearchBoxSuggestionFilter | FOnAssetSearchBoxSuggestionFilter | Delegate to filter the given suggestion list, to allow custom filtering behavior | SAssetSearchBox.h | |
| OnKeyDownHandler | FOnKeyDown | Delegate for first chance handling for key down events | SAssetSearchBox.h | |
| OnTextChanged | FOnTextChanged | Delegate for when text is changed in the edit box | SAssetSearchBox.h | |
| OnTextCommitted | FOnTextCommitted | Delegate for when text is changed in the edit box | SAssetSearchBox.h | |
| PossibleSuggestions | TAttribute< TArray< FAssetSearchBoxSuggestion > > | All possible suggestions for the search text | SAssetSearchBox.h | |
| PreCommittedText | FText | The the state of the text prior to being committed | SAssetSearchBox.h | |
| SuggestionBox | TSharedPtr< SMenuAnchor > | Auto completion elements | SAssetSearchBox.h | |
| SuggestionHighlightText | FText | The highlight text to use for the suggestions list | SAssetSearchBox.h | |
| SuggestionListView | TSharedPtr< SListView< TSharedPtr< FSuggestionListEntry > > > | The list view for showing all suggestions | SAssetSearchBox.h | |
| Suggestions | TArray< TSharedPtr< FSuggestionListEntry > > | All suggestions stored in this widget for the list view | SAssetSearchBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs this widget with InArgs | SAssetSearchBox.h | |
| Set or clear the current error reporting information for this search box | SAssetSearchBox.h | ||
| SAssetSearchBox.h | |||
void SetOnSaveSearchHandler
(
SFilterSearchBox::FOnSaveSearchClicked InOnSaveSearchHandler |
Show a + button next to the current search and set the handler for when that is clicked | SAssetSearchBox.h | |
void SetText
(
const TAttribute< FText >& InNewText |
Sets the text string currently being edited | SAssetSearchBox.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HasKeyboardFocus() |
SAssetSearchBox.h | ||
virtual FReply OnFocusReceived
(
const FGeometry& MyGeometry, |
SAssetSearchBox.h | ||
| SWidget implementation. | SAssetSearchBox.h | ||
virtual bool SupportsKeyboardFocus() |
SAssetSearchBox.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default implementation of OnAssetSearchBoxSuggestionChosen, if no external implementation is provided | SAssetSearchBox.h | ||
static void DefaultSuggestionFilterImpl
(
const FText& SearchText, |
Default implementation of OnAssetSearchBoxSuggestionFilter, if no external implementation is provided | SAssetSearchBox.h |