SFilterBar

Navigation

API > API/Editor > API/Editor/EditorWidgets

A Filter Bar widget, which can be used to filter items of type [FilterType] given a list of custom filters along with built in support for Asset Type filters Sample Usage: SAssignNew(MyFilterBar, SFilterBar) .OnFilterChanged() // A delegate for when the list of filters changes .CustomFilters() // An array of filters available to this FilterBar ( Use the GetAllActiveFilters() function to get the FilterCollection of Active Filters in this FilterBar, that can be used to filter your items. NOTE: GetAllActiveFilters() must be called every time the filters change (in OnFilterChanged() for example) to make sure you have the correct backend filter NOTE: Use CustomClassFilters to provide any Type Filters to make sure they get resolved properly (See FCustomClassFilterData) NOTE: Use MakeAddFilterButton() to make the button that summons the dropdown showing all the filters

Syntax

template<typename FilterType>  
class SFilterBar : public SAssetFilterBar< FilterType >  
Copy full snippet

template<typename FilterType> class SFilterBar : public SAssetFilterBar< FilterType >

Inheritance Hierarchy

• FFilterBarBase → SAssetFilterBar → SFilterBar
• FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBasicFilterBar → SAssetFilterBar → SFilterBar
• FSlateControlledConstruction → SWidget → SCompoundWidget → SBasicFilterBar → SAssetFilterBar → SFilterBar
• SFilterBar

Structs

Typedefs

Variables

Protected

Functions

Public

Overridden from SBasicFilterBar

See Also

• SBasicFilterBar if you don't want Asset Type filters

• or if you want a filter bar usable in non-editor situations NOTE: You will need to also add "ToolWidgets" as a dependency to your module to use this widget NOTE: The filter functions create copies

• so you want to use SFilterBar> etc instead of SFilterBar when possible NOTE: The user must specify one of the following: a) OnConvertItemToAssetData: A conversion function to convert FilterType to an FAssetData. Specifying this will filter the asset type through the AssetRegistry

• which is potentially more thorough and fast b) OnCompareItemWithClassName: A comparison function to check if an Item (FilterType) is the same as an AssetType (represented by an FName). This allows to user to directly text compare with ClassNames (UObjectBase::GetFName)

• which is easier but potentially slower

• FGenericFilter to create simple delegate based filters) .OnConvertItemToAssetData() // Conversion Function as mentioned above