Inheritance diagram for TSLSLMEntityRefHandlerCustom:

Detailed Description

Specialist EntityRefHandler for handling user-defined storage of entity references.

Public Member Functions
	TSLSLMEntityRefHandlerCustom ()

bool	isValid () const

void	setClientEntityRefHandler (TSLSLMEntityRefHandlerClientCustom *client)

void *	operator new (size_t) TSL_NO_THROW

void *	operator new (size_t, char *, int)

Public Member Functions inherited from TSLSLMEntityRefHandler
TSLSLMEntityRef *	addEntityRef (const TSLEntity *entity)

void	clearEntityRefFoundStatus ()

TSLSeamlessLayerConfig *	config ()

void	destroy ()

TSLSLMEntityRef *	getEntityRef (const TSLEntityID &entityID)

TSLSLMEntityRef *	getEntityRef (const TSLEntity *entity)

bool	getOrphanEntityRefs (TSLSLMEntityRef ***references, int &number)

const char *	layerName () const

const TSLSeamlessLayerManager *	manager () const

bool	removeEntityRef (const TSLEntityID &entityID)

TSLSLMEntityRefHandlerType	type ()

bool	updateEntityRef (TSLSLMEntityRef *entityRef)

TSLSLMEntityRefValidationEnum	validateEntityRef (TSLEntityID entityID, TSLVersion version)

bool	validateEntityRefsFromFiles (const TSLSLMEntityRef references, int referenceCount, const TSLSimpleString &path, TSLSLMEntityRef &failures, int &failuresCount)

void	cacheSize (long size)

Protected Member Functions
	~TSLSLMEntityRefHandlerCustom ()

Protected Member Functions inherited from TSLSLMEntityRefHandler
	TSLSLMEntityRefHandler ()

	~TSLSLMEntityRefHandler ()

Constructor & Destructor Documentation

◆ TSLSLMEntityRefHandlerCustom()

TSLSLMEntityRefHandlerCustom::TSLSLMEntityRefHandlerCustom ( )

Default constructor.

◆ ~TSLSLMEntityRefHandlerCustom()

TSLSLMEntityRefHandlerCustom::~TSLSLMEntityRefHandlerCustom ( )

protected

Protected destructor to stop being instantiated on the stack. Forces user to use new operator and destroy method.

Member Function Documentation

◆ isValid()

bool TSLSLMEntityRefHandlerCustom::isValid ( ) const

Returns true if a TSLSLMEntityRefHandlerClientCustom object has been attached, false otherwise.

◆ operator new() [1/2]

void * TSLSLMEntityRefHandlerCustom::operator new ( size_t )

Allocation override for API redirection.

◆ operator new() [2/2]

void * TSLSLMEntityRefHandlerCustom::operator new	(	size_t	,
		char *	,
		int	)

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

◆ setClientEntityRefHandler()

void TSLSLMEntityRefHandlerCustom::setClientEntityRefHandler ( TSLSLMEntityRefHandlerClientCustom * client )

Attaches an instance of TSLSLMEntityRefHandlerClientCustom to the TSLSLMEntityRefHandlerCustom.

This should be used to attach a handle to the developer's TSLSLMEntityRefHandler-derived class.

Parameters

client A pointer to a TSLSLMEntityRefHandler-derived class.