FSlateAttributeMetaData Class Reference

#include <SlateAttributeMetaData.h>

Inheritance diagram for FSlateAttributeMetaData:

Public Types
enum class	EInvalidationPermission : uint8 {   AllowInvalidationIfConstructed , AllowInvalidation , DelayInvalidation , DenyInvalidation ,   DenyAndClearDelayedInvalidation }

Public Member Functions
	SLATE_METADATA_TYPE (FSlateAttributeMetaData, ISlateMetaData)
	FSlateAttributeMetaData ()=default
	FSlateAttributeMetaData (const FSlateAttributeMetaData &)=delete
FSlateAttributeMetaData &	operator= (const FSlateAttributeMetaData &)=delete
bool	IsBound (const FSlateAttributeBase &Attribute) const
int32	GetRegisteredAttributeCount () const
int32	GetRegisteredAffectVisibilityAttributeCount () const
Public Member Functions inherited from ISlateMetaData
template<class TType >
bool	IsOfType () const
virtual	~ISlateMetaData ()

Static Public Member Functions
static SLATECORE_API FSlateAttributeMetaData *	FindMetaData (const SWidget &OwningWidget)
static SLATECORE_API void	UpdateAllAttributes (SWidget &OwningWidget, EInvalidationPermission InvalidationStyle)
static SLATECORE_API void	UpdateOnlyVisibilityAttributes (SWidget &OwningWidget, EInvalidationPermission InvalidationStyle)
static SLATECORE_API void	UpdateExceptVisibilityAttributes (SWidget &OwningWidget, EInvalidationPermission InvalidationStyle)
static SLATECORE_API void	UpdateChildrenOnlyVisibilityAttributes (SWidget &OwningWidget, EInvalidationPermission InvalidationStyle, bool bRecursive)
static SLATECORE_API void	ApplyDelayedInvalidation (SWidget &OwningWidget)
static SLATECORE_API TArray< FName >	GetAttributeNames (const SWidget &OwningWidget)

Friends
const TCHAR *	DebugSlateAttribute (const SWidget *Widget, int32 Index)

Additional Inherited Members
Protected Member Functions inherited from ISlateMetaData
virtual bool	IsOfTypeImpl (const FName &Type) const

Member Enumeration Documentation

EInvalidationPermission

enum class FSlateAttributeMetaData::EInvalidationPermission : uint8

strong

Enumerator
AllowInvalidationIfConstructed	Invalidate the widget if it's needed and it's construction phase is completed.
AllowInvalidation	Invalidate the widget if it's needed.
DelayInvalidation	Cache the invalidation. On any future update, if it's needed, invalidate the widget.
DenyInvalidation	Never invalidate the widget.
DenyAndClearDelayedInvalidation	Never invalidate the widget and clear any delayed invalidation.

Constructor & Destructor Documentation

FSlateAttributeMetaData() [1/2]

FSlateAttributeMetaData::FSlateAttributeMetaData ( )

default

FSlateAttributeMetaData() [2/2]

FSlateAttributeMetaData::FSlateAttributeMetaData ( const FSlateAttributeMetaData &  )

delete

Member Function Documentation

ApplyDelayedInvalidation()

void FSlateAttributeMetaData::ApplyDelayedInvalidation ( SWidget &  OwningWidget )

static

Apply any delayed invalidation previously delayed with EInvalidationPermission::DelayInvalidation.

FindMetaData()

FSlateAttributeMetaData * FSlateAttributeMetaData::FindMetaData ( const SWidget &  OwningWidget )

static

Returns

the instance associated to the SWidget (if it exists).

GetAttributeNames()

TArray< FName > FSlateAttributeMetaData::GetAttributeNames ( const SWidget &  OwningWidget )

static

Get the name of all the attributes, if available.

GetRegisteredAffectVisibilityAttributeCount()

int32 FSlateAttributeMetaData::GetRegisteredAffectVisibilityAttributeCount ( ) const

inline

GetRegisteredAttributeCount()

int32 FSlateAttributeMetaData::GetRegisteredAttributeCount ( ) const

inline

IsBound()

bool FSlateAttributeMetaData::IsBound ( const FSlateAttributeBase &  Attribute ) const

inline

operator=()

FSlateAttributeMetaData & FSlateAttributeMetaData::operator= ( const FSlateAttributeMetaData &  )

delete

SLATE_METADATA_TYPE()

FSlateAttributeMetaData::SLATE_METADATA_TYPE	(	FSlateAttributeMetaData	,
		ISlateMetaData
	)

UpdateAllAttributes()

void FSlateAttributeMetaData::UpdateAllAttributes ( SWidget &  OwningWidget, EInvalidationPermission  InvalidationStyle  )

static

Update all the attributes.

Parameters

InvalidationStyle

if we should invalidate the widget.

UpdateChildrenOnlyVisibilityAttributes()

void FSlateAttributeMetaData::UpdateChildrenOnlyVisibilityAttributes ( SWidget &  OwningWidget, EInvalidationPermission  InvalidationStyle, bool  bRecursive  )

static

Execute UpdateOnlyVisibilityAttributes on every children of the widget.

Parameters

InvalidationStyle

if we should invalidate the widget.

UpdateExceptVisibilityAttributes()

void FSlateAttributeMetaData::UpdateExceptVisibilityAttributes ( SWidget &  OwningWidget, EInvalidationPermission  InvalidationStyle  )

static

Update attributes that are NOT responsible to change visibility of the widget.

Parameters

InvalidationStyle

if we should invalidate the widget.

UpdateOnlyVisibilityAttributes()

void FSlateAttributeMetaData::UpdateOnlyVisibilityAttributes ( SWidget &  OwningWidget, EInvalidationPermission  InvalidationStyle  )

static

Update attributes that are responsible to change visibility of the widget.

Parameters

InvalidationStyle

if we should invalidate the widget.

Friends And Related Symbol Documentation

DebugSlateAttribute

const TCHAR * DebugSlateAttribute ( const SWidget *  Widget, int32  Index  )

friend

Helper function that can be used inside the debuggers watch window. E.g. "DebugSlateAttribute(this, 0)" E.g. "DebugSlateAttribute((SWidget*)(0x123456789), 0)"

---

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

• Engine/Source/Runtime/SlateCore/Public/Types/SlateAttributeMetaData.h
• Engine/Source/Runtime/SlateCore/Private/Types/SlateAttributeMetaData.cpp