Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
A generic widget for selecting an item from an array of items including optional filtering and categorization.
| Name | SItemSelector |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/Widgets/SItemSelector.h |
| Include Path | #include "Widgets/SItemSelector.h" |
Syntax
template<typename CategoryType, typename ItemType, typename SectionType, typename CategoryKeyType, typename ItemKeyType, typename SectionKeyType>
class SItemSelector : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SItemSelector
- FSlateControlledConstruction → SWidget → SCompoundWidget → SItemSelector
Classes
Structs
| Name | Remarks |
|---|---|
| FArguments | |
| FSectionData |
Interfaces
| Name | Remarks |
|---|---|
| IItemSelectorItemViewModelUtilities |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCategoryActivated | TBaseDelegate_OneParam< void, const CategoryType & > | Widgets/SItemSelector.h | |
| FOnCategoryExpansionChanged | TBaseDelegate_TwoParams< void, const CategoryType &, bool > | Widgets/SItemSelector.h | |
| FOnCategoryPassesFilter | TBaseDelegate_OneParam< bool, const CategoryType & > | Widgets/SItemSelector.h | |
| FOnCompareCategoriesForEquality | TBaseDelegate_TwoParams< bool, const CategoryType &, const CategoryType & > | Widgets/SItemSelector.h | |
| FOnCompareCategoriesForSorting | TBaseDelegate_TwoParams< bool, const CategoryType &, const CategoryType & > | Widgets/SItemSelector.h | |
| FOnCompareItemsForEquality | TBaseDelegate_TwoParams< bool, const ItemType &, const ItemType & > | Widgets/SItemSelector.h | |
| FOnCompareItemsForSorting | TBaseDelegate_TwoParams< bool, const ItemType &, const ItemType & > | Widgets/SItemSelector.h | |
| FOnCompareSectionsForEquality | TBaseDelegate_TwoParams< bool, const SectionType &, const SectionType & > | Widgets/SItemSelector.h | |
| FOnCompareSectionsForSorting | TBaseDelegate_TwoParams< bool, const SectionType &, const SectionType & > | Widgets/SItemSelector.h | |
| FOnDoesItemMatchFilterText | TBaseDelegate_TwoParams< bool, const FText &, const ItemType & > | Widgets/SItemSelector.h | |
| FOnDoesItemPassCustomFilter | TBaseDelegate_OneParam< bool, const ItemType & > | Widgets/SItemSelector.h | |
| FOnDoesSectionPassCustomFilter | TBaseDelegate_OneParam< bool, const SectionType & > | Widgets/SItemSelector.h | |
| FOnGenerateWidgetForCategory | TBaseDelegate_OneParam< TSharedRef< SWidget >, const CategoryType & > | Widgets/SItemSelector.h | |
| FOnGenerateWidgetForItem | TBaseDelegate_OneParam< TSharedRef< SWidget >, const ItemType & > | Widgets/SItemSelector.h | |
| FOnGenerateWidgetForSection | TBaseDelegate_OneParam< TSharedRef< SWidget >, const SectionType & > | Widgets/SItemSelector.h | |
| FOnGetCategoriesForItem | TBaseDelegate_OneParam< TArray< CategoryType >, const ItemType & > | Widgets/SItemSelector.h | |
| FOnGetCategoryBackgroundImage | TBaseDelegate_TwoParams< const FSlateBrush *, bool, bool > | Widgets/SItemSelector.h | |
| FOnGetItemWeight | TBaseDelegate_TwoParams< int32, const ItemType &, const TArray< FString > & > | Widgets/SItemSelector.h | |
| FOnGetKeyForCategory | TBaseDelegate_OneParam< const CategoryKeyType &, const CategoryType & > | Widgets/SItemSelector.h | |
| FOnGetKeyForItem | TBaseDelegate_OneParam< const ItemKeyType &, const ItemType & > | Widgets/SItemSelector.h | |
| FOnGetKeyForSection | TBaseDelegate_OneParam< const SectionKeyType &, const SectionType & > | Widgets/SItemSelector.h | |
| FOnGetSectionData | TBaseDelegate_OneParam< FSectionData, const SectionType & > | Widgets/SItemSelector.h | |
| FOnGetSectionsForItem | TBaseDelegate_OneParam< TArray< SectionType >, const ItemType & > | Widgets/SItemSelector.h | |
| FOnItemActivated | TBaseDelegate_OneParam< void, const ItemType & > | Widgets/SItemSelector.h | |
| FOnItemRowHoverEvent | TBaseDelegate_TwoParams< void, const ItemType &, bool > | Widgets/SItemSelector.h | |
| FOnItemsDragged | TBaseDelegate_TwoParams< FReply, const TArray< ItemType > &, const FPointerEvent & > | Widgets/SItemSelector.h | |
| FOnItemSelected | TBaseDelegate_TwoParams< void, const ItemType &, ESelectInfo::Type > | Widgets/SItemSelector.h | |
| FOnSelectionChanged | TBaseDelegate_NoParams< void > | Widgets/SItemSelector.h | |
| FOnSuggestionUpdated | TBaseDelegate_OneParam< void, int32 > | Widgets/SItemSelector.h | |
| SItemSelectorTableRow | STableRow< TSharedRef< FItemSelectorItemViewModel > > | Widgets/SItemSelector.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsSettingExpansion | bool | Widgets/SItemSelector.h | ||
| bIsSettingSelection | bool | Widgets/SItemSelector.h | ||
| bPreserveExpansionOnRefresh | bool | Widgets/SItemSelector.h | ||
| bPreserveSelectionOnRefresh | bool | Widgets/SItemSelector.h | ||
| CategoryBorderBackgroundColor | FLinearColor | Widgets/SItemSelector.h | ||
| CategoryBorderBackgroundPadding | FMargin | Widgets/SItemSelector.h | ||
| CategoryChildSlotPadding | FMargin | Widgets/SItemSelector.h | ||
| CategoryRowStyle | const FTableRowStyle * | Widgets/SItemSelector.h | ||
| ClickActivateMode | EItemSelectorClickActivateMode | Widgets/SItemSelector.h | ||
| DefaultCategoryPaths | TArray< TArray< CategoryType > > | Widgets/SItemSelector.h | ||
| HideSingleSection | TAttribute< bool > | Widgets/SItemSelector.h | ||
| ItemRowStyle | const FTableRowStyle * | Widgets/SItemSelector.h | ||
| Items | TArray< ItemType > | Widgets/SItemSelector.h | ||
| ItemTree | TSharedPtr< STreeView< TSharedRef< FItemSelectorItemViewModel > > > | Widgets/SItemSelector.h | ||
| OnCategoryActivated | FOnCategoryActivated | Widgets/SItemSelector.h | ||
| OnCategoryExpansionChanged | FOnCategoryExpansionChanged | Widgets/SItemSelector.h | ||
| OnCompareCategoriesForEquality | FOnCompareCategoriesForEquality | Widgets/SItemSelector.h | ||
| OnCompareCategoriesForSorting | FOnCompareCategoriesForSorting | Widgets/SItemSelector.h | ||
| OnCompareItemsForEquality | FOnCompareItemsForEquality | Widgets/SItemSelector.h | ||
| OnCompareItemsForSorting | FOnCompareItemsForSorting | Widgets/SItemSelector.h | ||
| OnCompareSectionsForEquality | FOnCompareSectionsForEquality | Widgets/SItemSelector.h | ||
| OnCompareSectionsForSorting | FOnCompareSectionsForSorting | Widgets/SItemSelector.h | ||
| OnDoesItemMatchFilterText | FOnDoesItemMatchFilterText | Widgets/SItemSelector.h | ||
| OnDoesItemPassCustomFilter | FOnDoesItemPassCustomFilter | Widgets/SItemSelector.h | ||
| OnDoesSectionPassCustomFilter | FOnDoesSectionPassCustomFilter | Widgets/SItemSelector.h | ||
| OnGenerateWidgetForCategory | FOnGenerateWidgetForCategory | Widgets/SItemSelector.h | ||
| OnGenerateWidgetForItem | FOnGenerateWidgetForItem | Widgets/SItemSelector.h | ||
| OnGenerateWidgetForSection | FOnGenerateWidgetForSection | Widgets/SItemSelector.h | ||
| OnGetCategoriesForItem | FOnGetCategoriesForItem | Widgets/SItemSelector.h | ||
| OnGetCategoryBackgroundImage | FOnGetCategoryBackgroundImage | Widgets/SItemSelector.h | ||
| OnGetItemWeight | FOnGetItemWeight | Widgets/SItemSelector.h | ||
| OnGetKeyForCategory | FOnGetKeyForCategory | Widgets/SItemSelector.h | ||
| OnGetKeyForItem | FOnGetKeyForItem | Widgets/SItemSelector.h | ||
| OnGetKeyForSection | FOnGetKeyForSection | Widgets/SItemSelector.h | ||
| OnGetSectionData | FOnGetSectionData | Widgets/SItemSelector.h | ||
| OnGetSectionsForItem | FOnGetSectionsForItem | Widgets/SItemSelector.h | ||
| OnItemActivated | FOnItemActivated | Widgets/SItemSelector.h | ||
| OnItemRowHoverEventDelegate | FOnItemRowHoverEvent | Widgets/SItemSelector.h | ||
| OnItemsDragged | FOnItemsDragged | Widgets/SItemSelector.h | ||
| OnItemSelected | FOnItemSelected | Widgets/SItemSelector.h | ||
| OnSelectionChanged | FOnSelectionChanged | Widgets/SItemSelector.h | ||
| OnSuggestionUpdated | FOnSuggestionUpdated | Widgets/SItemSelector.h | ||
| SearchBox | TSharedPtr< SSearchBox > | Widgets/SItemSelector.h | ||
| SearchBoxAdjacentContentWidget | TSharedPtr< SWidget > | Widgets/SItemSelector.h | ||
| SectionRowStyle | const FTableRowStyle * | Widgets/SItemSelector.h | ||
| ViewModelUtilities | TSharedPtr< FItemSelectorViewModel > | Widgets/SItemSelector.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearSelectedItems() |
Widgets/SItemSelector.h | ||
void Construct
(
const FArguments& InArgs |
Widgets/SItemSelector.h | ||
void ExpandTree() |
Widgets/SItemSelector.h | ||
void ExpandTreeByFilter
(
const FOnCategoryPassesFilter& InFilter |
Widgets/SItemSelector.h | ||
const FText & GetFilterText() |
Widgets/SItemSelector.h | ||
FText GetFilterTextNoRef() |
Widgets/SItemSelector.h | ||
TSharedRef< SWidget > GetSearchBox() |
Widgets/SItemSelector.h | ||
TArray< CategoryType > GetSelectedCategories() |
Widgets/SItemSelector.h | ||
TArray< ItemType > GetSelectedItems() |
Widgets/SItemSelector.h | ||
bool IsFiltering() |
Widgets/SItemSelector.h | ||
bool IsItemSelected
(
const ItemType Item |
Widgets/SItemSelector.h | ||
bool IsPendingRefresh() |
Widgets/SItemSelector.h | ||
bool IsSearching() |
Widgets/SItemSelector.h | ||
void RefreshAllCurrentItems
(
bool bForceExpansion |
Widgets/SItemSelector.h | ||
void RefreshItems
(
const TArray< ItemType >& InItems |
Widgets/SItemSelector.h | ||
void RefreshItemsAndDefaultCategories
(
const TArray< ItemType >& InItems, |
Widgets/SItemSelector.h | ||
void RefreshItemsAndDefaultCategories
(
const TArray< ItemType >& InItems, |
Widgets/SItemSelector.h | ||
void RequestScrollIntoView
(
const ItemType& Item |
Widgets/SItemSelector.h | ||
void SetSelectedItems
(
const TArray< ItemType >& NewSelectedItems, |
Widgets/SItemSelector.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Widgets/SItemSelector.h |