XII Release 0.1.0
Loading...
Searching...
No Matches
xiiPropertyMetaState Class Reference

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

#include <PropertyMetaState.h>

Public Member Functions

void GetTypePropertiesState (const xiiDocumentObject *pObject, xiiMap< xiiString, xiiPropertyUiState > &out_propertyStates)
 Queries the property meta state for a single xiiDocumentObject.
 
void GetTypePropertiesState (const xiiHybridArray< xiiPropertySelection, 8 > &items, xiiMap< xiiString, xiiPropertyUiState > &out_propertyStates)
 Queries the property meta state for a multi selection of xiiDocumentObject's.
 
void GetContainerElementsState (const xiiDocumentObject *pObject, xiiStringView sProperty, xiiHashTable< xiiVariant, xiiPropertyUiState > &out_propertyStates)
 Queries the meta state for the elements of a single container property on one xiiDocumentObject.
 
void GetContainerElementsState (const xiiHybridArray< xiiPropertySelection, 8 > &items, xiiStringView sProperty, xiiHashTable< xiiVariant, xiiPropertyUiState > &out_propertyStates)
 Queries the meta state for the elements of a single container property on a multi selection of xiiDocumentObjects.
 

Public Attributes

xiiEvent< xiiPropertyMetaStateEvent & > m_Events
 
xiiEvent< xiiContainerElementMetaStateEvent & > 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 xiiDocumentObject's. This triggers the xiiPropertyMetaStateEvent 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

◆ GetContainerElementsState()

void xiiPropertyMetaState::GetContainerElementsState ( const xiiHybridArray< xiiPropertySelection, 8 > & items,
xiiStringView sProperty,
xiiHashTable< xiiVariant, xiiPropertyUiState > & out_propertyStates )

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

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

◆ GetTypePropertiesState()

void xiiPropertyMetaState::GetTypePropertiesState ( const xiiHybridArray< xiiPropertySelection, 8 > & items,
xiiMap< xiiString, xiiPropertyUiState > & out_propertyStates )

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

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

Member Data Documentation

◆ m_ContainerEvents

xiiEvent<xiiContainerElementMetaStateEvent&> xiiPropertyMetaState::m_ContainerEvents

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

◆ m_Events

xiiEvent<xiiPropertyMetaStateEvent&> xiiPropertyMetaState::m_Events

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


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