UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Protected Member Functions | List of all members
TPanelChildren< SlotType > Class Template Referencefinal

#include <Children.h>

+ Inheritance diagram for TPanelChildren< SlotType >:

Classes

struct  FScopedWidgetSlotArguments
 

Public Member Functions

virtual int32 Num () const override
 
virtual TSharedRef< SWidget > GetChildAt (int32 Index) override
 
virtual TSharedRef< const SWidget > GetChildAt (int32 Index) const override
 
virtual bool SupportSlotWithSlateAttribute () const override
 
int32 AddSlot (typename SlotType::FSlotArguments &&SlotArgument)
 
void AddSlots (TArray< typename SlotType::FSlotArguments > SlotArguments)
 
void RemoveAt (int32 Index)
 
int32 Remove (const TSharedRef< SWidget > &SlotWidget)
 
void Empty (int32 Slack=0)
 
void InsertSlot (typename SlotType::FSlotArguments &&SlotArgument, int32 Index)
 
void Move (int32 IndexToMove, int32 IndexToDestination)
 
void Reserve (int32 NumToReserve)
 
bool IsValidIndex (int32 Index) const
 
const SlotType & operator[] (int32 Index) const
 
SlotType & operator[] (int32 Index)
 
template<class PREDICATE_CLASS >
void Sort (const PREDICATE_CLASS &Predicate)
 
template<class PREDICATE_CLASS >
void StableSort (const PREDICATE_CLASS &Predicate)
 
void Swap (int32 IndexA, int32 IndexB)
 
 FChildren (SWidget *InOwner)
 
 FChildren (SWidget *InOwner, FName InName)
 
 FChildren (std::nullptr_t)=delete
 
- Public Member Functions inherited from FChildren
 FChildren (SWidget *InOwner)
 
 FChildren (SWidget *InOwner, FName InName)
 
 FChildren (std::nullptr_t)=delete
 
void * operator new (size_t)=delete
 
void * operator new[] (size_t)=delete
 
SWidget & GetOwner () const
 
template<typename Predicate >
void ForEachWidget (Predicate &&Pred)
 
template<typename Predicate >
void ForEachWidget (Predicate &&Pred) const
 
virtual int32 NumSlot () const
 
FName GetName () const
 

Protected Member Functions

virtual const FSlotBase & GetSlotAt (int32 ChildIndex) const override
 
virtual FWidgetRef GetChildRefAt (int32 ChildIndex) override
 
virtual FConstWidgetRef GetChildRefAt (int32 ChildIndex) const override
 
- Protected Member Functions inherited from FChildren
virtual ~FChildren ()
 
void Debug_TestDestroyTag () const
 

Additional Inherited Members

- Protected Types inherited from FChildren
enum  ECopyConstruct { CopyConstruct }
 
enum  ERefConstruct { ReferenceConstruct }
 

Detailed Description

template<typename SlotType>
class TPanelChildren< SlotType >

A generic FChildren that stores children along with layout-related information. The type containing Widget* and layout info is specified by ChildType. ChildType must have a public member SWidget* Widget;

Member Function Documentation

◆ AddSlot()

template<typename SlotType >
int32 TPanelChildren< SlotType >::AddSlot ( typename SlotType::FSlotArguments &&  SlotArgument)
inline

◆ AddSlots()

template<typename SlotType >
void TPanelChildren< SlotType >::AddSlots ( TArray< typename SlotType::FSlotArguments >  SlotArguments)
inline

◆ Empty()

template<typename SlotType >
void TPanelChildren< SlotType >::Empty ( int32  Slack = 0)
inline

◆ FChildren() [1/3]

template<typename SlotType >
FChildren::FChildren ( std::nullptr_t  )
delete

◆ FChildren() [2/3]

template<typename SlotType >
FChildren::FChildren ( SWidget *  InOwner)
inline

◆ FChildren() [3/3]

template<typename SlotType >
FChildren::FChildren ( SWidget *  InOwner,
FName  InName 
)
inline

◆ GetChildAt() [1/2]

template<typename SlotType >
virtual TSharedRef< const SWidget > TPanelChildren< SlotType >::GetChildAt ( int32  Index) const
inlineoverridevirtual
Returns
const pointer to the Widget at the specified Index.

Implements FChildren.

◆ GetChildAt() [2/2]

template<typename SlotType >
virtual TSharedRef< SWidget > TPanelChildren< SlotType >::GetChildAt ( int32  Index)
inlineoverridevirtual
Returns
pointer to the Widget at the specified Index.

Implements FChildren.

◆ GetChildRefAt() [1/2]

template<typename SlotType >
virtual FConstWidgetRef TPanelChildren< SlotType >::GetChildRefAt ( int32  Index) const
inlineoverrideprotectedvirtual
Returns
ref to the Widget at the specified Index.

Implements FChildren.

◆ GetChildRefAt() [2/2]

template<typename SlotType >
virtual FWidgetRef TPanelChildren< SlotType >::GetChildRefAt ( int32  Index)
inlineoverrideprotectedvirtual
Returns
ref to the Widget at the specified Index.

Implements FChildren.

◆ GetSlotAt()

template<typename SlotType >
virtual const FSlotBase & TPanelChildren< SlotType >::GetSlotAt ( int32  ChildIndex) const
inlineoverrideprotectedvirtual
Returns
the const reference to the slot at the specified Index

Implements FChildren.

◆ InsertSlot()

template<typename SlotType >
void TPanelChildren< SlotType >::InsertSlot ( typename SlotType::FSlotArguments &&  SlotArgument,
int32  Index 
)
inline

◆ IsValidIndex()

template<typename SlotType >
bool TPanelChildren< SlotType >::IsValidIndex ( int32  Index) const
inline

◆ Move()

template<typename SlotType >
void TPanelChildren< SlotType >::Move ( int32  IndexToMove,
int32  IndexToDestination 
)
inline

◆ Num()

template<typename SlotType >
virtual int32 TPanelChildren< SlotType >::Num ( ) const
inlineoverridevirtual
Returns
the number of children

Implements FChildren.

◆ operator[]() [1/2]

template<typename SlotType >
SlotType & TPanelChildren< SlotType >::operator[] ( int32  Index)
inline

◆ operator[]() [2/2]

template<typename SlotType >
const SlotType & TPanelChildren< SlotType >::operator[] ( int32  Index) const
inline

◆ Remove()

template<typename SlotType >
int32 TPanelChildren< SlotType >::Remove ( const TSharedRef< SWidget > &  SlotWidget)
inline

Removes the corresponding widget from the set of children if it exists. Returns the index it found the child at, INDEX_NONE otherwise.

◆ RemoveAt()

template<typename SlotType >
void TPanelChildren< SlotType >::RemoveAt ( int32  Index)
inline

◆ Reserve()

template<typename SlotType >
void TPanelChildren< SlotType >::Reserve ( int32  NumToReserve)
inline

◆ Sort()

template<typename SlotType >
template<class PREDICATE_CLASS >
void TPanelChildren< SlotType >::Sort ( const PREDICATE_CLASS &  Predicate)
inline

◆ StableSort()

template<typename SlotType >
template<class PREDICATE_CLASS >
void TPanelChildren< SlotType >::StableSort ( const PREDICATE_CLASS &  Predicate)
inline

◆ SupportSlotWithSlateAttribute()

template<typename SlotType >
virtual bool TPanelChildren< SlotType >::SupportSlotWithSlateAttribute ( ) const
inlineoverridevirtual
Returns
if the Children can support slot with SlateSlotAttribute.

Reimplemented from FChildren.

◆ Swap()

template<typename SlotType >
void TPanelChildren< SlotType >::Swap ( int32  IndexA,
int32  IndexB 
)
inline
The documentation for this class was generated from the following file: