FSlateInvalidationWidgetList Class Reference

#include <SlateInvalidationWidgetList.h>

Classes
struct	FArguments
struct	FIndexRange
struct	FWidgetAttributeIterator
struct	FWidgetVolatileUpdateIterator
struct	IProcessChildOrderInvalidationCallback

Public Types
using	InvalidationWidgetType = FWidgetProxy

Public Member Functions
	FSlateInvalidationWidgetList (FSlateInvalidationRootHandle Owner, const FArguments &Args)
void	BuildWidgetList (const TSharedRef< SWidget > &Root)
TWeakPtr< SWidget >	GetRoot ()
const TWeakPtr< SWidget >	GetRoot () const
bool	ProcessChildOrderInvalidation (FSlateInvalidationWidgetIndex WidgetIndex, IProcessChildOrderInvalidationCallback &Callback)
void	ProcessAttributeRegistrationInvalidation (const InvalidationWidgetType &InvalidationWidget)
void	ProcessVolatileUpdateInvalidation (InvalidationWidgetType &InvalidationWidget)
template<typename Predicate >
void	ForEachWidget (Predicate Pred)
template<typename Predicate >
void	ForEachWidget (Predicate Pred) const
template<typename Predicate >
void	ForEachInvalidationWidget (Predicate Pred)
template<typename Predicate >
void	ForEachInvalidationWidget (Predicate Pred) const
template<typename Predicate >
void	ForEachInvalidationWidget (FSlateInvalidationWidgetIndex BellowWidgetIndex, Predicate Pred)
FWidgetAttributeIterator	CreateWidgetAttributeIterator () const
FWidgetVolatileUpdateIterator	CreateWidgetVolatileUpdateIterator (bool bSkipCollapsed) const
InvalidationWidgetType &	operator[] (const FSlateInvalidationWidgetIndex Index)
const InvalidationWidgetType &	operator[] (const FSlateInvalidationWidgetIndex Index) const
bool	IsValidIndex (const FSlateInvalidationWidgetIndex Index) const
bool	IsEmpty () const
FSlateInvalidationWidgetIndex	FirstIndex () const
FSlateInvalidationWidgetIndex	LastIndex () const
FSlateInvalidationWidgetIndex	IncrementIndex (FSlateInvalidationWidgetIndex Index) const
FSlateInvalidationWidgetIndex	DecrementIndex (FSlateInvalidationWidgetIndex Index) const
FSlateInvalidationWidgetIndex	FindNextSibling (FSlateInvalidationWidgetIndex WidgetIndex) const
void	Empty ()
void	Reset ()
bool	ShouldDoRecursion (const SWidget &Widget) const
bool	ShouldDoRecursion (const TSharedRef< const SWidget > &Widget) const

Static Public Member Functions
static bool	ShouldBeAdded (const SWidget &Widget)
static bool	ShouldBeAdded (const TSharedRef< const SWidget > &Widget)
static bool	ShouldBeAddedToAttributeList (const SWidget &Widget)
static bool	ShouldBeAddedToAttributeList (const TSharedRef< const SWidget > &Widget)
static bool	HasVolatileUpdateFlags (EWidgetUpdateFlags UpdateFlags)
static bool	ShouldBeAddedToVolatileUpdateList (const SWidget &Widget)
static bool	ShouldBeAddedToVolatileUpdateList (const TSharedRef< const SWidget > &Widget)

Friends
struct	FSlateInvalidationWidgetSortOrder

Member Typedef Documentation

InvalidationWidgetType

using FSlateInvalidationWidgetList::InvalidationWidgetType = FWidgetProxy

Constructor & Destructor Documentation

FSlateInvalidationWidgetList()

FSlateInvalidationWidgetList::FSlateInvalidationWidgetList	(	FSlateInvalidationRootHandle	Owner,
		const FArguments &	Args
	)

Member Function Documentation

BuildWidgetList()

void FSlateInvalidationWidgetList::BuildWidgetList

(

const TSharedRef< SWidget > &

Root

)

Build the widget list from the root widget.

CreateWidgetAttributeIterator()

FWidgetAttributeIterator FSlateInvalidationWidgetList::CreateWidgetAttributeIterator ( ) const

inline

CreateWidgetVolatileUpdateIterator()

FWidgetVolatileUpdateIterator FSlateInvalidationWidgetList::CreateWidgetVolatileUpdateIterator ( bool  bSkipCollapsed ) const

inline

DecrementIndex()

FSlateInvalidationWidgetIndex FSlateInvalidationWidgetList::DecrementIndex

(

FSlateInvalidationWidgetIndex

Index

)

const

Decrement a widget index to the next entry in the WidgetList.

Empty()

void FSlateInvalidationWidgetList::Empty

(

)

Empties the WidgetList.

FindNextSibling()

FSlateInvalidationWidgetIndex FSlateInvalidationWidgetList::FindNextSibling

(

FSlateInvalidationWidgetIndex

WidgetIndex

)

const

Find the next widget index that share the same parent. Return Invalid if there is no sibling.

FirstIndex()

FSlateInvalidationWidgetIndex FSlateInvalidationWidgetList::FirstIndex ( ) const

inline

Returns the first index from the WidgetList.

ForEachInvalidationWidget() [1/3]

template<typename Predicate >

void FSlateInvalidationWidgetList::ForEachInvalidationWidget ( FSlateInvalidationWidgetIndex  BellowWidgetIndex, Predicate  Pred  )

inline

Performs an operation on all InvalidationWidget in the list bellow the provided (WidgetIndex not including it).

ForEachInvalidationWidget() [2/3]

template<typename Predicate >

void FSlateInvalidationWidgetList::ForEachInvalidationWidget ( Predicate  Pred )

inline

Performs an operation on all InvalidationWidget in the list.

ForEachInvalidationWidget() [3/3]

template<typename Predicate >

void FSlateInvalidationWidgetList::ForEachInvalidationWidget ( Predicate  Pred ) const

inline

Performs an operation on all InvalidationWidget in the list.

ForEachWidget() [1/2]

template<typename Predicate >

void FSlateInvalidationWidgetList::ForEachWidget ( Predicate  Pred )

inline

Performs an operation on all SWidget in the list.

ForEachWidget() [2/2]

template<typename Predicate >

void FSlateInvalidationWidgetList::ForEachWidget ( Predicate  Pred ) const

inline

Performs an operation on all SWidget in the list.

GetRoot() [1/2]

TWeakPtr< SWidget > FSlateInvalidationWidgetList::GetRoot ( )

inline

Get the root the widget list was built with.

GetRoot() [2/2]

const TWeakPtr< SWidget > FSlateInvalidationWidgetList::GetRoot ( ) const

inline

Get the root the widget list was built with.

HasVolatileUpdateFlags()

static bool FSlateInvalidationWidgetList::HasVolatileUpdateFlags ( EWidgetUpdateFlags  UpdateFlags )

inlinestatic

IncrementIndex()

FSlateInvalidationWidgetIndex FSlateInvalidationWidgetList::IncrementIndex

(

FSlateInvalidationWidgetIndex

Index

)

const

Increment a widget index to the next entry in the WidgetList.

IsEmpty()

bool FSlateInvalidationWidgetList::IsEmpty ( ) const

inline

Returns true if there is not element in the WidgetList.

IsValidIndex()

bool FSlateInvalidationWidgetList::IsValidIndex ( const FSlateInvalidationWidgetIndex  Index ) const

inline

Tests if index is in the WidgetList range.

LastIndex()

FSlateInvalidationWidgetIndex FSlateInvalidationWidgetList::LastIndex ( ) const

inline

Returns the last index from the WidgetList.

operator[]() [1/2]

InvalidationWidgetType & FSlateInvalidationWidgetList::operator[] ( const FSlateInvalidationWidgetIndex  Index )

inline

Returns reference to element at give index.

operator[]() [2/2]

const InvalidationWidgetType & FSlateInvalidationWidgetList::operator[] ( const FSlateInvalidationWidgetIndex  Index ) const

inline

Returns reference to element at give index.

ProcessAttributeRegistrationInvalidation()

void FSlateInvalidationWidgetList::ProcessAttributeRegistrationInvalidation

(

const InvalidationWidgetType &

InvalidationWidget

)

Test, then adds or removes from the registered attribute list.

ProcessChildOrderInvalidation()

bool FSlateInvalidationWidgetList::ProcessChildOrderInvalidation	(	FSlateInvalidationWidgetIndex	WidgetIndex,
		IProcessChildOrderInvalidationCallback &	Callback
	)

Process widget that have a ChildOrder invalidation.

Note

the Invalidation may break the reference. You shouldn't use the InvalidationWidget after this point.

Returns

true if the WidgetIndex is still valid.

ProcessVolatileUpdateInvalidation()

void FSlateInvalidationWidgetList::ProcessVolatileUpdateInvalidation

(

InvalidationWidgetType &

InvalidationWidget

)

Test, then adds or removes from the volatile update list.

Reset()

void FSlateInvalidationWidgetList::Reset

(

)

Empties the WidgetList, but doesn't change the memory allocations.

ShouldBeAdded() [1/2]

static bool FSlateInvalidationWidgetList::ShouldBeAdded ( const SWidget &  Widget )

inlinestatic

ShouldBeAdded() [2/2]

static bool FSlateInvalidationWidgetList::ShouldBeAdded ( const TSharedRef< const SWidget > &  Widget )

inlinestatic

ShouldBeAddedToAttributeList() [1/2]

static bool FSlateInvalidationWidgetList::ShouldBeAddedToAttributeList ( const SWidget &  Widget )

inlinestatic

ShouldBeAddedToAttributeList() [2/2]

static bool FSlateInvalidationWidgetList::ShouldBeAddedToAttributeList ( const TSharedRef< const SWidget > &  Widget )

inlinestatic

ShouldBeAddedToVolatileUpdateList() [1/2]

static bool FSlateInvalidationWidgetList::ShouldBeAddedToVolatileUpdateList ( const SWidget &  Widget )

inlinestatic

ShouldBeAddedToVolatileUpdateList() [2/2]

static bool FSlateInvalidationWidgetList::ShouldBeAddedToVolatileUpdateList ( const TSharedRef< const SWidget > &  Widget )

inlinestatic

ShouldDoRecursion() [1/2]

bool FSlateInvalidationWidgetList::ShouldDoRecursion ( const SWidget &  Widget ) const

inline

ShouldDoRecursion() [2/2]

bool FSlateInvalidationWidgetList::ShouldDoRecursion ( const TSharedRef< const SWidget > &  Widget ) const

inline

Friends And Related Symbol Documentation

FSlateInvalidationWidgetSortOrder

friend struct FSlateInvalidationWidgetSortOrder

friend

---

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

• Engine/Source/Runtime/SlateCore/Private/FastUpdate/SlateInvalidationWidgetList.h
• Engine/Source/Runtime/SlateCore/Private/FastUpdate/SlateInvalidationWidgetList.cpp