AZ::DocumentPropertyEditor::NodeDefinition Struct Reference

#include <DocumentSchema.h>

Inherited by AZ::DocumentPropertyEditor::Nodes::NumericEditor< Dom::Value >, AZ::DocumentPropertyEditor::Nodes::Asset, AZ::DocumentPropertyEditor::Nodes::AudioControl, AZ::DocumentPropertyEditor::Nodes::Button, AZ::DocumentPropertyEditor::Nodes::CheckBox, AZ::DocumentPropertyEditor::Nodes::Color, AZ::DocumentPropertyEditor::Nodes::ComboBox, AZ::DocumentPropertyEditor::Nodes::Crc, AZ::DocumentPropertyEditor::Nodes::EntityId, AZ::DocumentPropertyEditor::Nodes::FilePath, AZ::DocumentPropertyEditor::Nodes::GenericButton, AZ::DocumentPropertyEditor::Nodes::LayoutPadding, AZ::DocumentPropertyEditor::Nodes::LineEdit, AZ::DocumentPropertyEditor::Nodes::MultiLineEdit, AZ::DocumentPropertyEditor::Nodes::NodeWithVisiblityControl, AZ::DocumentPropertyEditor::Nodes::NumericEditor< T >, AZ::DocumentPropertyEditor::Nodes::Quaternion, AZ::DocumentPropertyEditor::Nodes::RadioButton, AZ::DocumentPropertyEditor::Nodes::Vector2, AZ::DocumentPropertyEditor::Nodes::Vector3, and AZ::DocumentPropertyEditor::Nodes::Vector4.

Static Public Member Functions
static bool	CanAddToParentNode (const Dom::Value &parentNode)
static bool	CanBeParentToValue (const Dom::Value &value)

Static Public Attributes
static constexpr AZStd::string_view	Name = "<undefined node name>"

Detailed Description

Defines a schema definition for a DocumentAdapter node. Nodes have a name and metadata for validating their contents. To register a Node you may inherit from NodeDefinition and define traits: struct MyNode : NodeDefinition { static constexpr AZStd::string_view Name = "MyNode"; static bool CanAddToParentNode(const Dom::Value& parentNode); };

Member Function Documentation

CanAddToParentNode()

static bool AZ::DocumentPropertyEditor::NodeDefinition::CanAddToParentNode ( const Dom::Value &  parentNode )

inlinestatic

If defined, specifies if this node may be added to a given parent (a DOM node). By default all parent nodes are accepted.

CanBeParentToValue()

static bool AZ::DocumentPropertyEditor::NodeDefinition::CanBeParentToValue ( const Dom::Value &  value )

inlinestatic

If defined, specifies if this node may receive a child (a DOM Value that may be of an arbitrary type). By default all values are accepted.

Member Data Documentation

Name

constexpr AZStd::string_view AZ::DocumentPropertyEditor::NodeDefinition::Name = "<undefined node name>"

staticconstexpr

Defines the Name of the node definition. This field must be defined for all NodeDefinitions.

---

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

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