Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UWidgetTree

UWidgetTree

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

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Blueprint

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Blueprint/WidgetTree.h
Include #include "Blueprint/WidgetTree.h"

Syntax

class UWidgetTree :  
    public UObject,  
    public INamedSlotInterface

Remarks

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

Variables

  Type Name Description
Protected variable TArray< TObjectPtr< UWidget > > AllWidgets  
Public variable TMap< FName, TObjectPtr< UWidget > > NamedSlotBindings 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.
Public variable TObjectPtr< UWidget > RootWidget The root widget of the tree

Constructors

  Type Name Description
Public function  

UWidgetTree ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function WidgetT *

ConstructWidget ( TSubclassOf< UWidget > WidgetClass,
FName WidgetName
)

 Constructs the widget, and adds it to the tree.
Public function 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
Public function Const UWidget *

FindWidget ( const FName& Name
)

 Finds the widget in the tree by name.
Public function Const UWidget *

FindWidget ( TSharedRef< SWidget > InWidget
)

 Finds a widget in the tree using the native widget as the key.
Public function Const WidgetT *

FindWidget ( const FName& Name
)

 Finds the widget in the tree by name and casts the return to the desired type.
Public function 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.
Public function Static UPanelWidget *

FindWidgetParent ( UWidget* Widget,
int32& OutChildIndex
)

 Gets the parent widget of a given widget, and potentially the child index.
Public function Const void

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

 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.
Public function Const void Iterates through all widgets including widgets contained in named slots, other than investigating named slots.
Public function 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.
Public function Const void

GetAllWidgets ( TArray< UWidget* >& Widgets
)

 Gathers all the widgets in the tree recursively
Public function Static void

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

 Gathers descendant child widgets of a parent widget.
Public function Virtual Const UWorld * Begin UObject.
Public function bool

RemoveWidget ( UWidget* Widget
)

 Removes the widget from the hierarchy and all sub widgets.
Public function Static bool

TryMoveWidgetToNewTree ( UWidget* Widget,
UWidgetTree* DestinationTree
)

 Attempts to move a constructed Widget to another tree. Returns true on a successful move.

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.

Overridden from INamedSlotInterface

  Type Name Description
Public function Virtual Const UWidget *

GetContentForSlot ( FName SlotName
)

 Gets the widget for a given slot by name, will return nullptr if no widget is in the slot.
Public function Virtual Const void

GetSlotNames ( TArray< FName >& SlotNames
)

 Gets the names for slots that we can store widgets into.
Public function Virtual void

SetContentForSlot ( FName SlotName,
UWidget* Content
)

 Sets the widget for a given slot by name.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page