FArrangedChildren Class Reference

#include <ArrangedChildren.h>

Public Types
typedef TArray< FArrangedWidget, TInlineAllocator< 4 > >	FArrangedWidgetArray

Public Member Functions
	FArrangedChildren (EVisibility InVisibilityFilter, bool bInAllow3DWidgets=false)
void	Reverse ()
void	AddWidget (EVisibility VisibilityOverride, const FArrangedWidget &InWidgetGeometry)
void	InsertWidget (EVisibility VisibilityOverride, const FArrangedWidget &InWidgetGeometry, int32 Index)
void	Reserve (FArrangedWidgetArray::SizeType Number)
SLATECORE_API void	AddWidget (const FArrangedWidget &InWidgetGeometry)
SLATECORE_API void	InsertWidget (const FArrangedWidget &InWidgetGeometry, int32 Index)
void	SetFilter (EVisibility InVisibility)
EVisibility	GetFilter () const
bool	Accepts (EVisibility InVisibility) const
bool	Allows3DWidgets () const
FArrangedWidgetArray &	GetInternalArray ()
const FArrangedWidgetArray &	GetInternalArray () const
int32	Num () const
const FArrangedWidget &	operator[] (int32 Index) const
FArrangedWidget &	operator[] (int32 Index)
const FArrangedWidget &	Last () const
FArrangedWidget &	Last ()
int32	FindItemIndex (const FArrangedWidget &ItemToFind) const
template<typename PredicateType >
int32	IndexOfByPredicate (const PredicateType &Pred) const
template<typename PredicateType >
int32	FindLastByPredicate (const PredicateType &Pred) const
void	Remove (int32 Index, int32 Count=1)
void	Append (const FArrangedChildren &Source)
void	Empty ()
bool	IsValidIndex (int32 Index)

Static Public Member Functions
static FArrangedChildren	Hittest2_FromArray (const TArrayView< FWidgetAndPointer > InWidgets)

Detailed Description

The results of an ArrangeChildren are always returned as an FArrangedChildren. FArrangedChildren supports a filter that is useful for excluding widgets with unwanted visibilities.

Member Typedef Documentation

FArrangedWidgetArray

typedef TArray<FArrangedWidget, TInlineAllocator<4> > FArrangedChildren::FArrangedWidgetArray

Constructor & Destructor Documentation

FArrangedChildren()

FArrangedChildren::FArrangedChildren ( EVisibility  InVisibilityFilter, bool  bInAllow3DWidgets = false  )

inline

Construct a new container for arranged children that only accepts children that match the VisibilityFilter. e.g. FArrangedChildren ArrangedChildren( VIS_All ); // Children will be included regardless of visibility FArrangedChildren ArrangedChildren( EVisibility::Visible ); // Only visible children will be included FArrangedChildren ArrangedChildren( EVisibility::Collapsed | EVisibility::Hidden ); // Only hidden and collapsed children will be included.

Member Function Documentation

Accepts()

bool FArrangedChildren::Accepts ( EVisibility  InVisibility ) const

inline

AddWidget() [1/2]

void FArrangedChildren::AddWidget

(

const FArrangedWidget &

InWidgetGeometry

)

Add an arranged widget (i.e. widget and its resulting geometry) to the list of Arranged children based on the the visibility filter and the arranged widget's visibility

AddWidget() [2/2]

void FArrangedChildren::AddWidget ( EVisibility  VisibilityOverride, const FArrangedWidget &  InWidgetGeometry  )

inline

Add an arranged widget (i.e. widget and its resulting geometry) to the list of Arranged children.

Parameters

VisibilityOverride	The arrange function may override the visibility of the widget for the purposes of layout or performance (i.e. prevent redundant call to Widget->GetVisibility())
InWidgetGeometry	The arranged widget (i.e. widget and its geometry)

Allows3DWidgets()

bool FArrangedChildren::Allows3DWidgets ( ) const

inline

Append()

void FArrangedChildren::Append ( const FArrangedChildren &  Source )

inline

Empty()

void FArrangedChildren::Empty ( )

inline

FindItemIndex()

int32 FArrangedChildren::FindItemIndex ( const FArrangedWidget &  ItemToFind ) const

inline

FindLastByPredicate()

template<typename PredicateType >

int32 FArrangedChildren::FindLastByPredicate ( const PredicateType &  Pred ) const

inline

GetFilter()

EVisibility FArrangedChildren::GetFilter ( ) const

inline

GetInternalArray() [1/2]

FArrangedWidgetArray & FArrangedChildren::GetInternalArray ( )

inline

GetInternalArray() [2/2]

const FArrangedWidgetArray & FArrangedChildren::GetInternalArray ( ) const

inline

Hittest2_FromArray()

static FArrangedChildren FArrangedChildren::Hittest2_FromArray ( const TArrayView< FWidgetAndPointer >  InWidgets )

inlinestatic

IndexOfByPredicate()

template<typename PredicateType >

int32 FArrangedChildren::IndexOfByPredicate ( const PredicateType &  Pred ) const

inline

InsertWidget() [1/2]

void FArrangedChildren::InsertWidget	(	const FArrangedWidget &	InWidgetGeometry,
		int32	Index
	)

InsertWidget() [2/2]

void FArrangedChildren::InsertWidget ( EVisibility  VisibilityOverride, const FArrangedWidget &  InWidgetGeometry, int32  Index  )

inline

IsValidIndex()

bool FArrangedChildren::IsValidIndex ( int32  Index )

inline

Last() [1/2]

FArrangedWidget & FArrangedChildren::Last ( )

inline

Last() [2/2]

const FArrangedWidget & FArrangedChildren::Last ( ) const

inline

Num()

int32 FArrangedChildren::Num ( ) const

inline

operator[]() [1/2]

FArrangedWidget & FArrangedChildren::operator[] ( int32  Index )

inline

operator[]() [2/2]

const FArrangedWidget & FArrangedChildren::operator[] ( int32  Index ) const

inline

Remove()

void FArrangedChildren::Remove ( int32  Index, int32  Count = 1  )

inline

Reserve()

void FArrangedChildren::Reserve ( FArrangedWidgetArray::SizeType  Number )

inline

Reserves sufficient memory for the given number of arranged widgets.

Reverse()

void FArrangedChildren::Reverse ( )

inline

Reverse the order of the arranged children

SetFilter()

void FArrangedChildren::SetFilter ( EVisibility  InVisibility )

inline

---

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

• Engine/Source/Runtime/SlateCore/Public/Layout/ArrangedChildren.h
• Engine/Source/Runtime/SlateCore/Private/Layout/ArrangedChildren.cpp