AZ::DocumentPropertyEditor::GenericValueAttributeDefinition< GenericValueType > Class Template Reference

Inherits AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >.

Public Types
using	GenericValuePair = AZStd::pair< GenericValueType, AZStd::string >

Public Member Functions
constexpr	GenericValueAttributeDefinition (AZStd::string_view name)
Dom::Value	ValueToDom (const GenericValuePair &attribute) const override
	Converts a value of this attribute's type to a DOM value.
AZ::Dom::Value	LegacyAttributeToDomValue (AZ::PointerObject instanceObject, AZ::Attribute *attribute) const override
AZStd::optional< GenericValuePair >	DomToValue (const Dom::Value &value) const override
	Converts a DOM value to an instance of AttributeType.
Public Member Functions inherited from AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >
constexpr	AttributeDefinition (AZStd::string_view name)
Name	GetName () const override
	Retrieves the name of this attribute, as used as a key in the DOM.
AZStd::optional< AZStd::pair< GenericValueType, AZStd::string > >	ExtractFromDomNode (const Dom::Value &node) const
	Extracts this value from a given Node, if this attribute is set there.
AZ::TypeId	GetTypeId () const override
	Gets this attribute's type ID.
AZStd::shared_ptr< AZ::Attribute >	DomValueToLegacyAttribute (const AZ::Dom::Value &value, bool fallback) const override

Static Public Attributes
static constexpr const char *	EntryDescriptionKey = "description"
static constexpr const char *	EntryValueKey = "value"

Additional Inherited Members
Protected Attributes inherited from AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >
AZStd::fixed_string< 128 >	m_name

Member Function Documentation

DomToValue()

template<typename GenericValueType >

AZStd::optional< GenericValuePair > AZ::DocumentPropertyEditor::GenericValueAttributeDefinition< GenericValueType >::DomToValue ( const Dom::Value &  value ) const

inlineoverridevirtual

Converts a DOM value to an instance of AttributeType.

Reimplemented from AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >.

LegacyAttributeToDomValue()

template<typename GenericValueType >

AZ::Dom::Value AZ::DocumentPropertyEditor::GenericValueAttributeDefinition< GenericValueType >::LegacyAttributeToDomValue ( AZ::PointerObject  instanceObject, AZ::Attribute *  attribute  ) const

inlineoverridevirtual

Converts this attribute from an AZ::Attribute to a Dom::Value usable in the DocumentPropertyEditor.

Parameters

fallback

if false, a Read<AttributeType> failure will return a null Value; if true, it will attempt a fallback on failure

Reimplemented from AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >.

ValueToDom()

template<typename GenericValueType >

Dom::Value AZ::DocumentPropertyEditor::GenericValueAttributeDefinition< GenericValueType >::ValueToDom ( const GenericValuePair &  attribute ) const

inlineoverridevirtual

Converts a value of this attribute's type to a DOM value.

Reimplemented from AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >.

---

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

• Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/DocumentSchema.h