Navigation
API > API/Developer > API/Developer/ToolWidgets
A searchable text combo box
| Name | SSearchableComboBox |
| Type | class |
| Header File | /Engine/Source/Developer/ToolWidgets/Public/SSearchableComboBox.h |
| Include Path | #include "SSearchableComboBox.h" |
Syntax
class SSearchableComboBox : public SComboButton
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SPanel → SMenuAnchor → SComboButton → SSearchableComboBox
- FSlateControlledConstruction → SWidget → SPanel → SMenuAnchor → SComboButton → SSearchableComboBox
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGenerateWidget | TSlateDelegates< TSharedPtr< FString > >::FOnGenerateWidget | Delegate type used to generate widgets that represent Options | SSearchableComboBox.h |
| FOnSelectionChanged | TSlateDelegates< TSharedPtr< FString > >::FOnSelectionChanged | SSearchableComboBox.h | |
| SComboListType | SListView< TSharedPtr< FString > > | Type of list used for showing menu options. | SSearchableComboBox.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAlwaysSelectItem | bool | If true OnSelectionChanged delegate is executed on every input. | SSearchableComboBox.h | |
| ComboListView | TSharedPtr< SComboListType > | The ListView that we pop up; visualized the available options. | SSearchableComboBox.h | |
| CustomScrollbar | TSharedPtr< SScrollBar > | The Scrollbar used in the ListView. | SSearchableComboBox.h | |
| FilteredOptionsSource | TArray< TSharedPtr< FString > > | Filtered list that is actually displayed | SSearchableComboBox.h | |
| ItemStyle | const FTableRowStyle * | The item style to use. | SSearchableComboBox.h | |
| MenuRowPadding | FMargin | The padding around each menu row | SSearchableComboBox.h | |
| OnComboBoxOpening | FOnComboBoxOpening | Delegate to invoke before the combo box is opening. | SSearchableComboBox.h | |
| OnGenerateWidget | FOnGenerateWidget | Delegate to invoke when we need to visualize an option as a widget. | SSearchableComboBox.h | |
| OnSelectionChanged | FOnSelectionChanged | Delegate that is invoked when the selected item in the combo box changes | SSearchableComboBox.h | |
| OptionsSource | const TArray< TSharedPtr< FString > > * | Source data for this combo box | SSearchableComboBox.h | |
| SearchField | TSharedPtr< SEditableTextBox > | The search field used for the combox box's contents | SSearchableComboBox.h | |
| SearchText | FText | Updated whenever search text is changed | SSearchableComboBox.h | |
| SelectedItem | TSharedPtr< FString > | The item currently selected in the combo box | SSearchableComboBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearSelection() |
SSearchableComboBox.h | ||
void Construct
(
const FArguments& InArgs |
Construct the widget from a declaration | SSearchableComboBox.h | |
TSharedPtr< FString > GetSelectedItem() |
SSearchableComboBox.h | ||
void RefreshOptions () |
Requests a list refresh after updating options Call SetSelectedItem to update the selected item if required | SSearchableComboBox.h | |
void SetSelectedItem
(
TSharedPtr< FString > InSelectedItem, |
Sets the selected item. | SSearchableComboBox.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetOptionsSource
(
const TArray< TSharedPtr< FString > >* InOptionsSource |
Set ths source data for this combo box | SSearchableComboBox.h |