UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FChildren Class Referenceabstract

#include <ChildrenBase.h>

+ Inheritance diagram for FChildren:

Classes

struct  FConstWidgetRef
 
struct  FWidgetRef
 

Public Member Functions

 FChildren (SWidget *InOwner)
 
 FChildren (SWidget *InOwner, FName InName)
 
 FChildren (std::nullptr_t)=delete
 
voidoperator new (size_t)=delete
 
voidoperator new[] (size_t)=delete
 
virtual int32 Num () const =0
 
virtual TSharedRef< SWidgetGetChildAt (int32 Index)=0
 
virtual TSharedRef< const SWidgetGetChildAt (int32 Index) const =0
 
SWidgetGetOwner () const
 
template<typename Predicate >
void ForEachWidget (Predicate &&Pred)
 
template<typename Predicate >
void ForEachWidget (Predicate &&Pred) const
 
virtual int32 NumSlot () const
 
virtual const FSlotBaseGetSlotAt (int32 ChildIndex) const =0
 
virtual bool SupportSlotWithSlateAttribute () const
 
FName GetName () const
 

Protected Types

enum  ECopyConstruct { CopyConstruct }
 
enum  ERefConstruct { ReferenceConstruct }
 

Protected Member Functions

virtual FWidgetRef GetChildRefAt (int32 Index)=0
 
virtual FConstWidgetRef GetChildRefAt (int32 Index) const =0
 
virtual ~FChildren ()
 
void Debug_TestDestroyTag () const
 

Friends

class FCombinedChildren
 
template<typename T >
class TOneDynamicChild
 

Detailed Description

FChildren is an interface that must be implemented by all child containers. It allows iteration over a list of any Widget's children regardless of how the underlying Widget happens to store its children.

FChildren is intended to be returned by the GetChildren() method.

Member Enumeration Documentation

◆ ECopyConstruct

Enumerator
CopyConstruct 

◆ ERefConstruct

Enumerator
ReferenceConstruct 

Constructor & Destructor Documentation

◆ FChildren() [1/3]

FChildren::FChildren ( SWidget InOwner)
inline

◆ FChildren() [2/3]

FChildren::FChildren ( SWidget InOwner,
FName  InName 
)
inline

◆ FChildren() [3/3]

FChildren::FChildren ( std::nullptr_t  )
delete

◆ ~FChildren()

virtual FChildren::~FChildren ( )
inlineprotectedvirtual

Member Function Documentation

◆ Debug_TestDestroyTag()

void FChildren::Debug_TestDestroyTag ( ) const
inlineprotected

There is no guarantee that it will work. The memory could have been reused and the new data can luckily matches what we are looking for.

◆ ForEachWidget() [1/2]

template<typename Predicate >
void FChildren::ForEachWidget ( Predicate &&  Pred)
inline

Applies the predicate to all the widgets contained by the FChildren.

◆ ForEachWidget() [2/2]

template<typename Predicate >
void FChildren::ForEachWidget ( Predicate &&  Pred) const
inline

Applies the predicate to all the widgets contained by the FChildren.

◆ GetChildAt() [1/2]

virtual TSharedRef< const SWidget > FChildren::GetChildAt ( int32  Index) const
pure virtual

◆ GetChildAt() [2/2]

virtual TSharedRef< SWidget > FChildren::GetChildAt ( int32  Index)
pure virtual

◆ GetChildRefAt() [1/2]

◆ GetChildRefAt() [2/2]

◆ GetName()

FName FChildren::GetName ( ) const
inline

Option to give a name to Children to SlotAttribute purposes or for debugging.

◆ GetOwner()

SWidget & FChildren::GetOwner ( ) const
inline
Returns
the SWidget that own the FChildren

◆ GetSlotAt()

◆ Num()

◆ NumSlot()

virtual int32 FChildren::NumSlot ( ) const
inlinevirtual
Returns
the number of slot the children has.

Reimplemented in FCombinedChildren.

◆ operator new()

void * FChildren::operator new ( size_t  )
delete

◆ operator new[]()

void * FChildren::operator new[] ( size_t  )
delete

◆ SupportSlotWithSlateAttribute()

Friends And Related Symbol Documentation

◆ FCombinedChildren

friend class FCombinedChildren
friend

◆ TOneDynamicChild

template<typename T >
friend class TOneDynamicChild
friend

The documentation for this class was generated from the following file: