TreeFilterHandler

Handles filtering and expanding a TreeView using an [IFilter](API\Runtime\Core\Misc\IFilter) implementation.

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Views/TreeFilterHandler.h

Include

#include "Framework/Views/TreeFilterHandler.h"

Syntax

template<typename ItemType>
class TreeFilterHandler

Remarks

Handles filtering and expanding a TreeView using an IFilter implementation.

Constructors

Name Description

Public function

TreeFilterHandler()

Functions

Name Description

Public function

bool

 

GetIsEnabled()

Gets whether or not filtering is enabled for the TreeView.

Public function

void

 

OnGetFilteredChildren

(
    ItemType Parent,
    TArray< ItemType >& FilteredChildr...
)

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.

Public function

void

 

RefreshAndFilterTree()

Refreshes the associated TreeView, filtering items if the filter is enabled.

Public function

void

 

RemoveCachedItem

(
    ItemType ItemToRemove
)

Removes any cached references to an item.

Public function

void

 

SetFilter

(
    IFilter< ItemType >* InFilter
)

Sets the filter which will be used to filter the items in the TreeView.

Public function

void

 

SetGetChildrenDelegate

(
    FOnGetChildren InGetChildrenDelegat...
)

Sets the delegate which should be used for traversing the children of the nodes in the tree.

Public function

void

 

SetIsEnabled

(
    bool bInIsEnabled
)

Sets whether or not filtering the tree is enabled.

Public function

void

 

SetRootItems

(
    TArray< ItemType >* InRootItem...,
    TArray< ItemType >* InTreeRoot...
)

Sets the root data arrays for the tree.

Public function

void

 

SetTreeView

(
    STreeView< ItemType >* InTreeV...
)

Sets the TreeView to be filtered.

Typedefs

Name

Description

FOnGetChildren
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss