Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Components > UTreeView

Light Theme

Dark Theme

UTreeView

Similar to ListView, but can display a hierarchical tree of elements.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UListViewBase

UListView

UTreeView

UCommonTreeView

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/TreeView.h
Include	#include "Components/TreeView.h"

Syntax

class UTreeView : public UListView

Remarks

Similar to ListView, but can display a hierarchical tree of elements. The base items source for the tree identifies the root items, each of which can have n associated child items. There is no hard limit to the nesting - child items can have children and so on

To make a widget usable as an entry in a TreeView, it must inherit from the IUserObjectListEntry interface.

Variables

		Name	Description
	TSharedPtr< STr...	MyTreeView

Constructors

	Name	Description
	UTreeView ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	CollapseAll()	Collapses all currently expanded items
TSharedRef< ...	ConstructTreeView()	STreeView construction helper - useful if using a custom STreeView subclass
void	ExpandAll()	Expands all items with children
void	SetItemExpansion ( UObject* Item, bool bExpandItem )	Attempts to expand/collapse the given item (only relevant if the item has children)
void	SetOnGetItemChildren ( ObjectT* InUserObject, typename TSlateDelegates< UObject&... )
void	SetOnGetItemChildren ( TSharedRef< ObjectT > InUserObject, typename TSlateDelegates< UObject&... )

Overridden from UListViewBase

		Name	Description
	TSharedRef< ...	RebuildListWidget()	Implement in child classes to construct the actual ListView Slate widget

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from ITypedUMGListView

	Name	Description
void	OnGetChildrenInternal ( UObject* Item, TArray< UObject* >& OutChildr... )	TreeViews only.
void	OnItemClickedInternal ( UObject* Item )	ListView events - implement these instead of binding handlers directly to a list
void	OnItemExpansionChangedInternal ( UObject* Item, bool bIsExpanded )