UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSlotBase Class Reference

#include <SlotBase.h>

+ Inheritance diagram for FSlotBase:

Classes

struct  FSlotArguments
 

Public Member Functions

SLATECORE_API FSlotBase ()
 
SLATECORE_API FSlotBase (const FChildren &InParent)
 
SLATECORE_API FSlotBase (const TSharedRef< SWidget > &InWidget)
 
FSlotBaseoperator= (const FSlotBase &)=delete
 
 FSlotBase (const FSlotBase &)=delete
 
virtual SLATECORE_API ~FSlotBase ()
 
const FChildrenGetOwner () const
 
SLATECORE_API SWidgetGetOwnerWidget () const
 
SLATECORE_API void SetOwner (const FChildren &Children)
 
void AttachWidget (TSharedRef< SWidget > &&InWidget)
 
void AttachWidget (const TSharedRef< SWidget > &InWidget)
 
const TSharedRef< SWidget > & GetWidget () const
 
SLATECORE_API const TSharedPtr< SWidgetDetachWidget ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 

Protected Member Functions

template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 

Detailed Description

Slot are a container of a SWidget used by the FChildren.

Constructor & Destructor Documentation

◆ FSlotBase() [1/4]

FSlotBase::FSlotBase ( )

◆ FSlotBase() [2/4]

FSlotBase::FSlotBase ( const FChildren InParent)

◆ FSlotBase() [3/4]

FSlotBase::FSlotBase ( const TSharedRef< SWidget > &  InWidget)

◆ FSlotBase() [4/4]

FSlotBase::FSlotBase ( const FSlotBase )
delete

◆ ~FSlotBase()

FSlotBase::~FSlotBase ( )
virtual

Member Function Documentation

◆ AttachWidget() [1/2]

void FSlotBase::AttachWidget ( const TSharedRef< SWidget > &  InWidget)
inline

◆ AttachWidget() [2/2]

void FSlotBase::AttachWidget ( TSharedRef< SWidget > &&  InWidget)
inline

Attach the child widget the slot now owns.

◆ DetachWidget()

const TSharedPtr< SWidget > FSlotBase::DetachWidget ( )

Remove the widget from its current slot. The removed widget is returned so that operations could be performed on it. If the null widget was being stored, an invalid shared ptr is returned instead.

◆ GetOwner()

const FChildren * FSlotBase::GetOwner ( ) const
inline

Access the FChildren that own the slot. The owner can be invalid when the slot is not attached.

◆ GetOwnerWidget()

SWidget * FSlotBase::GetOwnerWidget ( ) const

Access the widget that own the slot. The owner can be invalid when the slot is not attached.

◆ GetWidget()

const TSharedRef< SWidget > & FSlotBase::GetWidget ( ) const
inline

Access the widget in the current slot. There will always be a widget in the slot; sometimes it is the SNullWidget instance.

◆ Invalidate()

void FSlotBase::Invalidate ( EInvalidateWidgetReason  InvalidateReason)

Invalidate the widget's owner.

◆ operator=()

FSlotBase & FSlotBase::operator= ( const FSlotBase )
delete

◆ SetAttribute()

bool FSlotBase::SetAttribute ( TAttribute< TargetValueType > &  TargetValue,
const TAttribute< SourceValueType > &  SourceValue,
EInvalidateWidgetReason  BaseInvalidationReason 
)
inlineprotected

Performs the attribute assignment and invalidates the widget minimally based on what actually changed. So if the boundness of the attribute didn't change volatility won't need to be recalculated. Returns true if the value changed.

◆ SetOwner()

void FSlotBase::SetOwner ( const FChildren Children)

Set the owner of the slot. Slots cannot be reassigned to different parents.


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