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

#include <ExposedParametersPropertyWidget.moc.h>

Inheritance diagram for xiiExposedParameterCommandAccessor:
[legend]

Public Member Functions

 xiiExposedParameterCommandAccessor (xiiObjectAccessorBase *pSource, const xiiAbstractProperty *pParameterProp, const xiiAbstractProperty *pM_pParameterSourceProp)
virtual xiiStatus GetValue (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiVariant &out_value, xiiVariant index=xiiVariant()) override
virtual xiiStatus SetValue (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, const xiiVariant &newValue, xiiVariant index=xiiVariant()) override
virtual xiiStatus RemoveValue (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiVariant index=xiiVariant()) override
virtual xiiStatus GetCount (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiInt32 &out_iCount) override
virtual xiiStatus GetKeys (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiDynamicArray< xiiVariant > &out_keys) override
virtual xiiStatus GetValues (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiDynamicArray< xiiVariant > &out_values) override
const xiiExposedParameters * GetExposedParams (const xiiDocumentObject *pObject)
const xiiExposedParameter * GetExposedParam (const xiiDocumentObject *pObject, xiiStringView sParamName)
const xiiRTTI * GetExposedParamsType (const xiiDocumentObject *pObject)
const xiiRTTI * GetCommonExposedParamsType (const xiiHybridArray< xiiPropertySelection, 8 > &items)
bool IsExposedProperty (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp)
Public Member Functions inherited from xiiObjectProxyAccessor
 xiiObjectProxyAccessor (xiiObjectAccessorBase *pSource)
xiiObjectAccessorBase * GetSourceAccessor () const
virtual void StartTransaction (xiiStringView sDisplayString) override
virtual void CancelTransaction () override
virtual void FinishTransaction () override
virtual void BeginTemporaryCommands (xiiStringView sDisplayString, bool bFireEventsWhenUndoingTempCommands=false) override
virtual void CancelTemporaryCommands () override
virtual void FinishTemporaryCommands () override
virtual const xiiDocumentObject * GetObject (const xiiUuid &object) override
virtual xiiStatus InsertValue (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, const xiiVariant &newValue, xiiVariant index=xiiVariant()) override
virtual xiiStatus MoveValue (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, const xiiVariant &oldIndex, const xiiVariant &newIndex) override
virtual xiiStatus AddObject (const xiiDocumentObject *pParent, const xiiAbstractProperty *pParentProp, const xiiVariant &index, const xiiRTTI *pType, xiiUuid &inout_objectGuid) override
virtual xiiStatus RemoveObject (const xiiDocumentObject *pObject) override
virtual xiiStatus MoveObject (const xiiDocumentObject *pObject, const xiiDocumentObject *pNewParent, const xiiAbstractProperty *pParentProp, const xiiVariant &index) override
Public Member Functions inherited from xiiObjectAccessorBase
const xiiDocumentObjectManager * GetObjectManager () const
xiiStatus GetValueByName (const xiiDocumentObject *pObject, xiiStringView sProp, xiiVariant &out_value, xiiVariant index=xiiVariant())
xiiStatus SetValueByName (const xiiDocumentObject *pObject, xiiStringView sProp, const xiiVariant &newValue, xiiVariant index=xiiVariant())
xiiStatus InsertValueByName (const xiiDocumentObject *pObject, xiiStringView sProp, const xiiVariant &newValue, xiiVariant index=xiiVariant())
xiiStatus RemoveValueByName (const xiiDocumentObject *pObject, xiiStringView sProp, xiiVariant index=xiiVariant())
xiiStatus MoveValueByName (const xiiDocumentObject *pObject, xiiStringView sProp, const xiiVariant &oldIndex, const xiiVariant &newIndex)
xiiStatus GetCountByName (const xiiDocumentObject *pObject, xiiStringView sProp, xiiInt32 &out_iCount)
xiiStatus AddObjectByName (const xiiDocumentObject *pParent, xiiStringView sParentProp, const xiiVariant &index, const xiiRTTI *pType, xiiUuid &inout_objectGuid)
xiiStatus MoveObjectByName (const xiiDocumentObject *pObject, const xiiDocumentObject *pNewParent, xiiStringView sParentProp, const xiiVariant &index)
xiiStatus GetKeysByName (const xiiDocumentObject *pObject, xiiStringView sProp, xiiDynamicArray< xiiVariant > &out_keys)
xiiStatus GetValuesByName (const xiiDocumentObject *pObject, xiiStringView sProp, xiiDynamicArray< xiiVariant > &out_values)
const xiiDocumentObject * GetChildObjectByName (const xiiDocumentObject *pObject, xiiStringView sProp, xiiVariant index)
xiiStatus ClearByName (const xiiDocumentObject *pObject, xiiStringView sProp)
const xiiAbstractProperty * FindPropertyByName (const xiiDocumentObject *pObject, xiiStringView sProp)
template<typename T>
T Get (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiVariant index=xiiVariant())
 Copyright (c) Theophilus Eriata. All Rights Reserved.
template<typename T>
T GetByName (const xiiDocumentObject *pObject, xiiStringView sProp, xiiVariant index=xiiVariant())
xiiInt32 GetCount (const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp)
xiiInt32 GetCountByName (const xiiDocumentObject *pObject, xiiStringView sProp)
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI * GetDynamicRTTI () const
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.

Public Attributes

const xiiAbstractProperty * m_pParameterProp = nullptr
const xiiAbstractProperty * m_pParameterSourceProp = nullptr

Additional Inherited Members

Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI * GetStaticRTTI ()
Protected Member Functions inherited from xiiObjectAccessorBase
 xiiObjectAccessorBase (const xiiDocumentObjectManager *pManager)
void FireDocumentObjectStructureEvent (const xiiDocumentObjectStructureEvent &e)
void FireDocumentObjectPropertyEvent (const xiiDocumentObjectPropertyEvent &e)
Protected Attributes inherited from xiiObjectProxyAccessor
xiiObjectAccessorBase * m_pSource = nullptr
Protected Attributes inherited from xiiObjectAccessorBase
const xiiDocumentObjectManager * m_pConstManager

Detailed Description

Helper accessor to pretend all exposed parameters always have a value defined. The exposed parameters are stored as just a sparse map. Only the elements that are overwritten from their defaults are actually stored in the component. Thus, requesting the value of an exposed parameter that has not been overwritten results in failure. To fix this, this class will automatically return the default value of an exposed parameter. This allows the tooling code to always show every exposed parameter's value independent on whether it was overwritten or remains at the default value.

Member Function Documentation

◆ GetCount()

xiiStatus xiiExposedParameterCommandAccessor::GetCount ( const xiiDocumentObject * pObject,
const xiiAbstractProperty * pProp,
xiiInt32 & out_iCount )
overridevirtual

Reimplemented from xiiObjectProxyAccessor.

◆ GetKeys()

xiiStatus xiiExposedParameterCommandAccessor::GetKeys ( const xiiDocumentObject * pObject,
const xiiAbstractProperty * pProp,
xiiDynamicArray< xiiVariant > & out_keys )
overridevirtual

Reimplemented from xiiObjectProxyAccessor.

◆ GetValue()

xiiStatus xiiExposedParameterCommandAccessor::GetValue ( const xiiDocumentObject * pObject,
const xiiAbstractProperty * pProp,
xiiVariant & out_value,
xiiVariant index = xiiVariant() )
overridevirtual

Reimplemented from xiiObjectProxyAccessor.

◆ GetValues()

xiiStatus xiiExposedParameterCommandAccessor::GetValues ( const xiiDocumentObject * pObject,
const xiiAbstractProperty * pProp,
xiiDynamicArray< xiiVariant > & out_values )
overridevirtual

Reimplemented from xiiObjectProxyAccessor.

◆ RemoveValue()

xiiStatus xiiExposedParameterCommandAccessor::RemoveValue ( const xiiDocumentObject * pObject,
const xiiAbstractProperty * pProp,
xiiVariant index = xiiVariant() )
overridevirtual

Reimplemented from xiiObjectProxyAccessor.

◆ SetValue()

xiiStatus xiiExposedParameterCommandAccessor::SetValue ( const xiiDocumentObject * pObject,
const xiiAbstractProperty * pProp,
const xiiVariant & newValue,
xiiVariant index = xiiVariant() )
overridevirtual

Reimplemented from xiiObjectProxyAccessor.


The documentation for this class was generated from the following files:
  • /home/runner/work/XII/XII/Source/Editor/EditorFramework/PropertyGrid/ExposedParametersPropertyWidget.moc.h
  • /home/runner/work/XII/XII/Source/Editor/EditorFramework/PropertyGrid/Implementation/ExposedParametersPropertyWidget.cpp