TTypedElementList< HandleType >::FLegacySync Class Reference

#include <TypedElementList.h>

Public Types
enum class	ESyncType : uint8 {   Added , Removed , Modified , Cleared ,   BatchComplete }

Public Member Functions
TYPEDELEMENTFRAMEWORK_API	FLegacySync (const TTypedElementList &InElementList)
TYPEDELEMENTFRAMEWORK_API void	Private_EmitSyncEvent (const ESyncType InSyncType, const HandleType &InElementHandle=HandleType())
	DECLARE_EVENT_FourParams (FLegacySync, FOnSyncEvent, const TTypedElementList &, ESyncType, const HandleType &, bool)
TYPEDELEMENTFRAMEWORK_API FOnSyncEvent &	OnSyncEvent ()
TYPEDELEMENTFRAMEWORK_API bool	IsRunningBatchOperation () const
TYPEDELEMENTFRAMEWORK_API void	BeginBatchOperation ()
TYPEDELEMENTFRAMEWORK_API void	EndBatchOperation (const bool InNotify=true)
TYPEDELEMENTFRAMEWORK_API bool	IsBatchOperationDirty () const
TYPEDELEMENTFRAMEWORK_API void	ForceBatchOperationDirty ()

Detailed Description

template<class HandleType>
class TTypedElementList< HandleType >::FLegacySync

Interface to allow external systems (such as USelection) to receive immediate sync notifications as an element list is changed. This exists purely as a bridging mechanism and shouldn't be relied on for new code. It is lazily created as needed.

Member Enumeration Documentation

ESyncType

template<class HandleType >

enum class TTypedElementList::FLegacySync::ESyncType : uint8

strong

Enumerator
Added	An element was added to the element list. The ElementHandle argument will be set to the element that was added.
Removed	An element was removed from the element list. The ElementHandle argument will be set to the element that was removed.
Modified	The element list was modified in an unknown way. The ElementHandle argument will be unset.
Cleared	The element list was cleared. The ElementHandle argument will be unset.
BatchComplete	The element list was modified as part of a batch or bulk operation. The ElementHandle argument will be unset. Note A batch operation will emit internal (bIsWithinBatchOperation=true) Added, Removed, Modified and Cleared updates during the batch, so if you respond to those internal updates you may choose to ignore this one. Otherwise you should treat it the same as Modified.

Constructor & Destructor Documentation

FLegacySync()

template<class HandleType >

TTypedElementList< HandleType >::FLegacySync::FLegacySync

(

const TTypedElementList &

InElementList

)

Member Function Documentation

BeginBatchOperation()

template<class HandleType >

void TTypedElementList< HandleType >::FLegacySync::BeginBatchOperation

(

)

DECLARE_EVENT_FourParams()

template<class HandleType >

TTypedElementList< HandleType >::FLegacySync::DECLARE_EVENT_FourParams	(	FLegacySync	,
		FOnSyncEvent	,
		const TTypedElementList &	,
		ESyncType	,
		const HandleType &	,
		bool
	)

EndBatchOperation()

template<class HandleType >

void TTypedElementList< HandleType >::FLegacySync::EndBatchOperation

(

const bool

InNotify = true

)

ForceBatchOperationDirty()

template<class HandleType >

void TTypedElementList< HandleType >::FLegacySync::ForceBatchOperationDirty

(

)

IsBatchOperationDirty()

template<class HandleType >

bool TTypedElementList< HandleType >::FLegacySync::IsBatchOperationDirty

(

)

const

IsRunningBatchOperation()

template<class HandleType >

bool TTypedElementList< HandleType >::FLegacySync::IsRunningBatchOperation

(

)

const

OnSyncEvent()

template<class HandleType >

TTypedElementList< HandleType >::FLegacySync::FOnSyncEvent & TTypedElementList< HandleType >::FLegacySync::OnSyncEvent

(

)

Private_EmitSyncEvent()

template<class HandleType >

void TTypedElementList< HandleType >::FLegacySync::Private_EmitSyncEvent	(	const ESyncType	InSyncType,
		const HandleType &	InElementHandle = HandleType()
	)

---

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

• Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementList.h
• Engine/Source/Runtime/TypedElementFramework/Private/Elements/Framework/TypedElementList.cpp