Navigation
API > API/Editor > API/Editor/Sequencer
A wrapper widget around SFilterSearchBox to provide filter text expression suggestions in a dropdown menu.
| Name | SSequencerSearchBox |
| Type | class |
| Header File | /Engine/Source/Editor/Sequencer/Public/Filters/Widgets/SSequencerSearchBox.h |
| Include Path | #include "Filters/Widgets/SSequencerSearchBox.h" |
Syntax
class SSequencerSearchBox : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SSequencerSearchBox
- FSlateControlledConstruction → SWidget → SCompoundWidget → SSequencerSearchBox
Structs
| Name | Remarks |
|---|---|
| FArguments | |
| FParsedExpression |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDisableOpeningSuggestions | bool | Filters/Widgets/SSequencerSearchBox.h | ||
| bMustMatchPossibleSuggestions | bool | Determines whether the committed text should match a suggestion | Filters/Widgets/SSequencerSearchBox.h | |
| LastChosenCursorOffset | int32 | Filters/Widgets/SSequencerSearchBox.h | ||
| LastCursorLocation | FTextLocation | Filters/Widgets/SSequencerSearchBox.h | ||
| OnKeyDownHandler | FOnKeyDown | Delegate for first chance handling for key down events | Filters/Widgets/SSequencerSearchBox.h | |
| OnSuggestionChosen | FOnSequencerSearchBoxSuggestionChosen | Delegate when a suggestion entry is chosen during a search, to allow custom compositing behavior of the suggestion into the search text | Filters/Widgets/SSequencerSearchBox.h | |
| OnSuggestionFilter | FOnSequencerSearchBoxSuggestionFilter | Delegate to filter the given suggestion list, to allow custom filtering behavior | Filters/Widgets/SSequencerSearchBox.h | |
| OnTextChanged | FOnTextChanged | Filters/Widgets/SSequencerSearchBox.h | ||
| OnTextCommitted | FOnTextCommitted | Filters/Widgets/SSequencerSearchBox.h | ||
| PossibleSuggestions | TAttribute< TArray< FSequencerFilterSuggestion > > | All possible suggestions for the search text | Filters/Widgets/SSequencerSearchBox.h | |
| PreCommittedText | FText | The state of the text prior to being committed | Filters/Widgets/SSequencerSearchBox.h | |
| SearchBox | TSharedPtr< SFilterSearchBox > | Filters/Widgets/SSequencerSearchBox.h | ||
| SuggestionHighlightText | FText | The highlight text to use for the suggestions list | Filters/Widgets/SSequencerSearchBox.h | |
| SuggestionItems | TArray< TSharedPtr< FSequencerFilterSuggestionListEntryBase > > | Filters/Widgets/SSequencerSearchBox.h | ||
| SuggestionListView | TSharedPtr< SListView< TSharedPtr< FSequencerFilterSuggestionListEntryBase > > > | Filters/Widgets/SSequencerSearchBox.h | ||
| SuggestionMenuAnchor | TSharedPtr< SMenuAnchor > | Filters/Widgets/SSequencerSearchBox.h | ||
| WeakFilterBar | TWeakPtr< ISequencerFilterBar > | Filters/Widgets/SSequencerSearchBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs, |
Constructs this widget with InArgs | Filters/Widgets/SSequencerSearchBox.h | |
FText GetText() |
Get the text string currently being edited | Filters/Widgets/SSequencerSearchBox.h | |
| Set or clear the current error reporting information for this search box | Filters/Widgets/SSequencerSearchBox.h | ||
| Filters/Widgets/SSequencerSearchBox.h | |||
void SetOnSaveSearchHandler
(
SFilterSearchBox::FOnSaveSearchClicked InOnSaveSearchHandler |
Show a + button next to the current search and set the handler for when that is clicked | Filters/Widgets/SSequencerSearchBox.h | |
void SetText
(
const TAttribute< FText >& InNewText |
Sets the text string currently being edited | Filters/Widgets/SSequencerSearchBox.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HasKeyboardFocus() |
Filters/Widgets/SSequencerSearchBox.h | ||
virtual FReply OnFocusReceived
(
const FGeometry& InGeometry, |
Filters/Widgets/SSequencerSearchBox.h | ||
| Filters/Widgets/SSequencerSearchBox.h | |||
virtual bool SupportsKeyboardFocus() |
Filters/Widgets/SSequencerSearchBox.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 FindTokenIndex
(
const TArray< TExpressionToken< TCHAR > >& ExpressionTokens, |
Filters/Widgets/SSequencerSearchBox.h | ||
static bool IsLogicalOperatorToken
(
const TExpressionToken< TCHAR >& InToken |
Filters/Widgets/SSequencerSearchBox.h | ||
static bool IsOperatorToken
(
const TExpressionToken< TCHAR >& InToken |
Filters/Widgets/SSequencerSearchBox.h |