This class allows to query additional information about how to present properties in the property grid. More...

Public Member Functions
void	GetTypePropertiesState (const plDocumentObject *pObject, plMap< plString, plPropertyUiState > &out_propertyStates)
	Queries the property meta state for a single plDocumentObject.

void	GetTypePropertiesState (const plHybridArray< plPropertySelection, 8 > &items, plMap< plString, plPropertyUiState > &out_propertyStates)
	Queries the property meta state for a multi selection of plDocumentObject's.

void	GetContainerElementsState (const plDocumentObject pObject, const char szProperty, plHashTable< plVariant, plPropertyUiState > &out_propertyStates)
	Queries the meta state for the elements of a single container property on one plDocumentObject.

void	GetContainerElementsState (const plHybridArray< plPropertySelection, 8 > &items, const char *szProperty, plHashTable< plVariant, plPropertyUiState > &out_propertyStates)
	Queries the meta state for the elements of a single container property on a multi selection of plDocumentObjects.

Public Attributes
plEvent< plPropertyMetaStateEvent & >	m_Events

plEvent< plContainerElementMetaStateEvent & >	m_ContainerEvents

Detailed Description

This class allows to query additional information about how to present properties in the property grid.

The property grid calls GetTypePropertiesState() and GetContainerElementsState() with the current selection of plDocumentObject's. This triggers the plPropertyMetaStateEvent to be broadcast, which allows for other code to determine additional information for the properties and write it into the event data.

Member Function Documentation

void plPropertyMetaState::GetContainerElementsState	(	const plHybridArray< plPropertySelection, 8 > &	items,
		const char *	szProperty,
		plHashTable< plVariant, plPropertyUiState > &	out_propertyStates )

Queries the meta state for the elements of a single container property on a multi selection of plDocumentObjects.

This will query the information for every single selected object and then merge the result into one.

void plPropertyMetaState::GetTypePropertiesState	(	const plHybridArray< plPropertySelection, 8 > &	items,
		plMap< plString, plPropertyUiState > &	out_propertyStates )

Queries the property meta state for a multi selection of plDocumentObject's.

This will query the information for every single selected object and then merge the result into one.

plEvent<plContainerElementMetaStateEvent&> plPropertyMetaState::m_ContainerEvents

Attach to this event to get notified of container element state queries. Add information to plContainerElementMetaStateEvent::m_pContainerElementStates to return data.

plEvent<plPropertyMetaStateEvent&> plPropertyMetaState::m_Events

Attach to this event to get notified of property state queries. Add information to plPropertyMetaStateEvent::m_pPropertyStates to return data.

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

Code/Tools/Libs/GuiFoundation/PropertyGrid/PropertyMetaState.h
Code/Tools/Libs/GuiFoundation/PropertyGrid/Implementation/PropertyMetaState.cpp