xiiDefaultState Class Reference

Registry for all xiiDefaultStateProvider factory functions. More...

#include <DefaultState.h>

Public Types
using	CreateStateProviderFunc = xiiSharedPtr<xiiDefaultStateProvider> (*)(xiiObjectAccessorBase*, const xiiDocumentObject*, const xiiAbstractProperty*)
	The functor interface for the xiiDefaultStateProvider factory function.

Static Public Member Functions
static void	RegisterDefaultStateProvider (CreateStateProviderFunc func)
	Registers a xiiDefaultStateProvider factory method. It is safe to register / unregister factories at any time.
static void	UnregisterDefaultStateProvider (CreateStateProviderFunc func)
	Unregisters a xiiDefaultStateProvider factory method.

Friends
class	xiiDefaultObjectState
class	xiiDefaultContainerState

Detailed Description

Registry for all xiiDefaultStateProvider factory functions.

Member Typedef Documentation

CreateStateProviderFunc

using xiiDefaultState::CreateStateProviderFunc = xiiSharedPtr<xiiDefaultStateProvider> (*)(xiiObjectAccessorBase*, const xiiDocumentObject*, const xiiAbstractProperty*)

The functor interface for the xiiDefaultStateProvider factory function.

The return value is a sharedPtr as each implementation can decide whether to provide the same instance for all objects or whether a custom instance should be created for each object to allow for state caching (e.g. prefab root information). Returning nullptr is also valid for objects / containers for which the factory has no use (e.g. prefab default state provider on an object that does not belong to a prefab). The function is called for xiiDefaultObjectState usage with the pProp field left blank. For xiiDefaultContainerState usage pProp will point to the container property.

---

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

• /home/runner/work/XII/XII/Source/Tools/Libs/GuiFoundation/PropertyGrid/DefaultState.h
• /home/runner/work/XII/XII/Source/Editor/EditorFramework/EditorApp/Implementation/Startup.cpp
• /home/runner/work/XII/XII/Source/Tools/Libs/GuiFoundation/PropertyGrid/Implementation/DefaultState.cpp