1. Epic GamesDeveloper
  3. UWidgetTree

UWidgetTree

The widget tree manages the collection of widgets in a blueprint widget.

API > API/Runtime > API/Runtime/UMG

The widget tree manages the collection of widgets in a blueprint widget.

   
Name UWidgetTree
Type class
Header File /Engine/Source/Runtime/UMG/Public/Blueprint/WidgetTree.h
Include Path #include "Blueprint/WidgetTree.h"

Syntax

UCLASS (MinimalAPI)  
class UWidgetTree :  
    public UObject ,  
    public INamedSlotInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UWidgetTree ( const FObjectInitializer& ObjectInitializer
)

   Blueprint/WidgetTree.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
NamedSlotBindings TMap< FName, TObjectPtr< UWidget > > Stores the widgets being assigned to named slots, these widgets will be slotted into the named slots of the user widget that owns this widget tree after the user widget is constructed. Blueprint/WidgetTree.h  
RootWidget TObjectPtr< UWidget > The root widget of the tree Blueprint/WidgetTree.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

WidgetT * ConstructWidget ( TSubclassOf< WidgetT > WidgetClass,
FName WidgetName
)

 Constructs the widget, and adds it to the tree. Blueprint/WidgetTree.h  

UWidget * FindWidget ( const FName& Name
) const

 Finds the widget in the tree by name. Blueprint/WidgetTree.h  

UWidget * FindWidget ( TSharedRef< SWidget > InWidget
) const

 Finds a widget in the tree using the native widget as the key. Blueprint/WidgetTree.h  

WidgetT * FindWidget ( const FName& Name
) const

 Finds the widget in the tree by name and casts the return to the desired type. Blueprint/WidgetTree.h  

void ForEachWidget ( TFunctionRef< void(UWidget*)> Predicate
) const

 Iterates through all widgets including widgets contained in named slots, other than investigating named slots, this code does not dive into foreign WidgetTrees, as would exist inside another user widget. Blueprint/WidgetTree.h  

void ForEachWidgetAndDescendants ( TFunctionRef< void(UWidget*)> Predicate
) const

 Iterates through all widgets including widgets contained in named slots, other than investigating named slots. Blueprint/WidgetTree.h  

void ForEachWidgetUntil ( TFunctionRef< bool(UWidget*)> Predicate
) const

 Iterates widgets according to ForEachWidget until Predicate returns false. Blueprint/WidgetTree.h  

void GetAllWidgets ( TArray< UWidget* >& Widgets
) const

 Gathers all the widgets in the tree recursively Blueprint/WidgetTree.h  

virtual UWorld * GetWorld()

 Begin UObject. Blueprint/WidgetTree.h  

bool RemoveWidget ( UWidget* Widget
)

 Removes the widget from the hierarchy and all sub widgets. Blueprint/WidgetTree.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Blueprint/WidgetTree.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Blueprint/WidgetTree.h  

Overridden from INamedSlotInterface

Name Remarks Include Path Unreal Specifiers

virtual UWidget * GetContentForSlot ( FName SlotName
) const

 Gets the widget for a given slot by name, will return nullptr if no widget is in the slot. Blueprint/WidgetTree.h  

virtual void GetSlotNames ( TArray< FName >& SlotNames
) const

 Gets the names for slots that we can store widgets into. Blueprint/WidgetTree.h  

virtual void SetContentForSlot ( FName SlotName,
UWidget* Content
)

 Sets the widget for a given slot by name. Blueprint/WidgetTree.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 FindChildIndex ( const UPanelWidget* ParentWidget,
const UWidget* ChildWidget
)

 Determines the child index of the given ParentWidget that the given ChildWidget ultimately occupies, accounting for nesting Blueprint/WidgetTree.h  

static UWidget * FindWidgetChild ( UPanelWidget* ParentWidget,
FName ChildWidgetName,
int32& OutChildIndex
)

 Searches recursively through the children of the given ParentWidget to find a child widget of the given name. Blueprint/WidgetTree.h  

static UPanelWidget * FindWidgetParent ( UWidget* Widget,
int32& OutChildIndex
)

 Gets the parent widget of a given widget, and potentially the child index. Blueprint/WidgetTree.h  

static bool ForEachWidgetAndChildrenUntil ( UWidget* Widget,
TFunctionRef< bool(UWidget*)> Predicate
)

 Iterates widgets according to ForWidgetAndChildren until Predicate returns false. Blueprint/WidgetTree.h  

static void ForWidgetAndChildren ( UWidget* Widget,
TFunctionRef< void(UWidget*)> Predicate
)

 Iterates through all child widgets including widgets contained in named slots, other than investigating named slots, this code does not dive into foreign WidgetTrees, as would exist inside another user widget. Blueprint/WidgetTree.h  

static void GetChildWidgets ( UWidget* Parent,
TArray< UWidget* >& Widgets
)

 Gathers descendant child widgets of a parent widget. Blueprint/WidgetTree.h  

static bool TryMoveWidgetToNewTree ( UWidget* Widget,
UWidgetTree* DestinationTree
)

 Attempts to move a constructed Widget to another tree. Returns true on a successful move. Blueprint/WidgetTree.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page