ezAbstractMapProperty Class Reference

The base class for a property that represents a set of values. More...

#include <AbstractProperty.h>

Inheritance diagram for ezAbstractMapProperty:

Public Member Functions
	ezAbstractMapProperty (const char *szPropertyName)
	Passes the property name through to ezAbstractProperty.
virtual ezPropertyCategory::Enum	GetCategory () const override
	Returns ezPropertyCategory::Map.
virtual bool	IsEmpty (const void *pInstance) const =0
	Returns whether the set is empty.
virtual void	Clear (void *pInstance) const =0
	Clears the set.
virtual void	Insert (void *pInstance, const char *szKey, const void *pObject) const =0
	Inserts the target of pObject into the set.
virtual void	Remove (void *pInstance, const char *szKey) const =0
	Removes the target of pObject from the set.
virtual bool	Contains (const void *pInstance, const char *szKey) const =0
	Returns whether the target of pObject is in the set.
virtual bool	GetValue (const void *pInstance, const char *szKey, void *pObject) const =0
	Writes element at index uiIndex to the target of pObject.
virtual void	GetKeys (const void *pInstance, ezHybridArray< ezString, 16 > &out_keys) const =0
	Writes the content of the set to out_keys.
Public Member Functions inherited from ezAbstractProperty
	ezAbstractProperty (const char *szPropertyName)
	The constructor must get the name of the property. The string must be a compile-time constant.
const char *	GetPropertyName () const
	Returns the name of the property.
virtual const ezRTTI *	GetSpecificType () const =0
	Returns the type information of the constant property. Use this to cast this property to a specific version of ezTypedConstantProperty.
const ezBitflags< ezPropertyFlags > &	GetFlags () const
	Returns the flags of the property.
ezAbstractProperty *	AddFlags (ezBitflags< ezPropertyFlags > flags)
	Adds flags to the property. Returns itself to allow to be called during initialization.
ezAbstractProperty *	AddAttributes (ezPropertyAttribute *pAttrib1, ezPropertyAttribute *pAttrib2=nullptr, ezPropertyAttribute *pAttrib3=nullptr, ezPropertyAttribute *pAttrib4=nullptr, ezPropertyAttribute *pAttrib5=nullptr, ezPropertyAttribute *pAttrib6=nullptr)
	Adds attributes to the property. Returns itself to allow to be called during initialization. Allocate an attribute using standard 'new'.
ezArrayPtr< const ezPropertyAttribute *const >	GetAttributes () const
	Returns the array of property attributes.
template<typename Type >
const Type *	GetAttributeByType () const
	Returns the first attribute that derives from the given type, or nullptr if nothing is found.

Additional Inherited Members
Protected Attributes inherited from ezAbstractProperty
ezBitflags< ezPropertyFlags >	m_Flags
const char *	m_szPropertyName
ezHybridArray< const ezPropertyAttribute *, 2, ezStaticsAllocatorWrapper >	m_Attributes

Detailed Description

The base class for a property that represents a set of values.

The element type must either be a standard type or a pointer.

Member Function Documentation

Clear()

virtual void ezAbstractMapProperty::Clear ( void *  pInstance ) const

pure virtual

Clears the set.

Implemented in ezAccessorMapProperty< Class, Type, Container >, ezWriteAccessorMapProperty< Class, Type, Container >, ezMemberMapProperty< Class, Container, Type >, and ezPhantomMapProperty.

Contains()

virtual bool ezAbstractMapProperty::Contains ( const void *  pInstance, const char *  szKey  ) const

pure virtual

Returns whether the target of pObject is in the set.

Implemented in ezAccessorMapProperty< Class, Type, Container >, ezWriteAccessorMapProperty< Class, Type, Container >, ezMemberMapProperty< Class, Container, Type >, and ezPhantomMapProperty.

GetCategory()

virtual ezPropertyCategory::Enum ezAbstractMapProperty::GetCategory ( ) const

inlineoverridevirtual

Returns ezPropertyCategory::Map.

Implements ezAbstractProperty.

GetKeys()

virtual void ezAbstractMapProperty::GetKeys ( const void *  pInstance, ezHybridArray< ezString, 16 > &  out_keys  ) const

pure virtual

Writes the content of the set to out_keys.

Implemented in ezAccessorMapProperty< Class, Type, Container >, ezWriteAccessorMapProperty< Class, Type, Container >, ezMemberMapProperty< Class, Container, Type >, and ezPhantomMapProperty.

GetValue()

virtual bool ezAbstractMapProperty::GetValue ( const void *  pInstance, const char *  szKey, void *  pObject  ) const

pure virtual

Writes element at index uiIndex to the target of pObject.

Implemented in ezAccessorMapProperty< Class, Type, Container >, ezWriteAccessorMapProperty< Class, Type, Container >, ezMemberMapProperty< Class, Container, Type >, and ezPhantomMapProperty.

Insert()

virtual void ezAbstractMapProperty::Insert ( void *  pInstance, const char *  szKey, const void *  pObject  ) const

pure virtual

Inserts the target of pObject into the set.

Implemented in ezAccessorMapProperty< Class, Type, Container >, ezWriteAccessorMapProperty< Class, Type, Container >, ezMemberMapProperty< Class, Container, Type >, and ezPhantomMapProperty.

IsEmpty()

virtual bool ezAbstractMapProperty::IsEmpty ( const void *  pInstance ) const

pure virtual

Returns whether the set is empty.

Implemented in ezAccessorMapProperty< Class, Type, Container >, ezWriteAccessorMapProperty< Class, Type, Container >, ezMemberMapProperty< Class, Container, Type >, and ezPhantomMapProperty.

Remove()

virtual void ezAbstractMapProperty::Remove ( void *  pInstance, const char *  szKey  ) const

pure virtual

Removes the target of pObject from the set.

Implemented in ezAccessorMapProperty< Class, Type, Container >, ezWriteAccessorMapProperty< Class, Type, Container >, ezMemberMapProperty< Class, Container, Type >, and ezPhantomMapProperty.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Foundation/Reflection/Implementation/AbstractProperty.h