Navigation
API > API/Runtime > API/Runtime/Slate
Handles filtering and expanding a TreeView using an IFilter implementation.
| Name | TreeFilterHandler |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Views/TreeFilterHandler.h |
| Include Path | #include "Framework/Views/TreeFilterHandler.h" |
Syntax
template<typename ItemType>
class TreeFilterHandler
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TreeFilterHandler() |
Framework/Views/TreeFilterHandler.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGetChildren | TSlateDelegates< ItemType >::FOnGetChildren | Framework/Views/TreeFilterHandler.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsEnabled | bool | Whether or not the collection will be filtered on refresh. | Framework/Views/TreeFilterHandler.h | |
| bWasEnabled | bool | Whether or not the tree was filtered the last time it was refreshed. | Framework/Views/TreeFilterHandler.h | |
| Filter | IFilter< ItemType > * | The filter to use for filtering. | Framework/Views/TreeFilterHandler.h | |
| GetChildrenDelegate | FOnGetChildren | A delegate to get the children for a node in the tree. | Framework/Views/TreeFilterHandler.h | |
| ItemsPassingFilter | TSet< ItemType > | A cache of the items which passed the filter. | Framework/Views/TreeFilterHandler.h | |
| PrefilterExpandedItems | TSet< ItemType > | A set of the items which were expanded in the tree before any filtering. | Framework/Views/TreeFilterHandler.h | |
| RootItems | TArray< ItemType > * | The source collection of root items for the tree. | Framework/Views/TreeFilterHandler.h | |
| TreeRootItems | TArray< ItemType > * | The collection of root items which is being displayed by the tree. | Framework/Views/TreeFilterHandler.h | |
| TreeView | STreeView< ItemType > * | The tree view to be filtered. | Framework/Views/TreeFilterHandler.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetIsEnabled() |
Gets whether or not filtering is enabled for the TreeView. | Framework/Views/TreeFilterHandler.h | |
void OnGetFilteredChildren
(
ItemType Parent, |
Gets the children for a node in the tree which pass the filter if filtering is enabled, or gets all children if the filter is not enabled. | Framework/Views/TreeFilterHandler.h | |
void RefreshAndFilterTree () |
Refreshes the associated TreeView, filtering items if the filter is enabled. | Framework/Views/TreeFilterHandler.h | |
void RemoveCachedItem
(
ItemType ItemToRemove |
Removes any cached references to an item. | Framework/Views/TreeFilterHandler.h | |
void SetFilter
(
IFilter< ItemType >* InFilter |
Sets the filter which will be used to filter the items in the TreeView. | Framework/Views/TreeFilterHandler.h | |
void SetGetChildrenDelegate
(
FOnGetChildren InGetChildrenDelegate |
Sets the delegate which should be used for traversing the children of the nodes in the tree. | Framework/Views/TreeFilterHandler.h | |
void SetIsEnabled
(
bool bInIsEnabled |
Sets whether or not filtering the tree is enabled. | Framework/Views/TreeFilterHandler.h | |
| Sets the root data arrays for the tree. | Framework/Views/TreeFilterHandler.h | ||
void SetTreeView
(
STreeView< ItemType >* InTreeView |
Sets the TreeView to be filtered. | Framework/Views/TreeFilterHandler.h |