Open 3D Engine AzFramework API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::DocumentPropertyEditor::Nodes::Adapter Struct Reference

Adapter: The top-level tag for a DocumentAdapter that may contain any number of Rows. More...

#include <PropertyEditorNodes.h>

Inherits AZ::DocumentPropertyEditor::Nodes::NodeWithVisiblityControl.

Static Public Member Functions

static bool CanAddToParentNode (const Dom::Value &parentNode)
 
static bool CanBeParentToValue (const Dom::Value &value)
 
- Static Public Member Functions inherited from AZ::DocumentPropertyEditor::NodeDefinition
static bool CanAddToParentNode (const Dom::Value &parentNode)
 
static bool CanBeParentToValue (const Dom::Value &value)
 

Static Public Attributes

static constexpr AZStd::string_view Name = "Adapter"
 
static constexpr auto QueryKey = CallbackAttributeDefinition<void(DocumentAdapterPtr*, AZ::Dom::Path)>("QueryKey")
 
static constexpr auto AddContainerKey = CallbackAttributeDefinition<void(DocumentAdapterPtr*, AZ::Dom::Path)>("AddContainerKey")
 
static constexpr auto RejectContainerKey = CallbackAttributeDefinition<void(AZ::Dom::Path)>("RejectContainerKey")
 
static constexpr auto QuerySubclass
 
static constexpr auto AddContainerSubclass
 
static constexpr auto SetNodeDisabled
 Use this callback attribute if there is need to enable/disable an adapter's nodes at runtime.
 
- Static Public Attributes inherited from AZ::DocumentPropertyEditor::Nodes::NodeWithVisiblityControl
static constexpr AZStd::string_view Name = "NodeWithVisiblityControl"
 
static constexpr auto Visibility = AttributeDefinition<PropertyVisibility>("Visibility")
 
static constexpr auto ReadOnly = AttributeDefinition<bool>("ReadOnly")
 
static constexpr auto NameLabelOverride = AttributeDefinition<AZStd::string_view>("NameLabelOverride")
 
static constexpr auto SetTrueLabel = AttributeDefinition<AZStd::string_view>("SetTrueLabel")
 
static constexpr auto SetFalseLabel = AttributeDefinition<AZStd::string_view>("SetFalseLabel")
 
static constexpr auto Disabled = AttributeDefinition<bool>("Disabled")
 
static constexpr auto AncestorDisabled = AttributeDefinition<bool>("AncestorDisabled")
 
- Static Public Attributes inherited from AZ::DocumentPropertyEditor::NodeDefinition
static constexpr AZStd::string_view Name = "<undefined node name>"
 

Detailed Description

Adapter: The top-level tag for a DocumentAdapter that may contain any number of Rows.

Member Data Documentation

◆ AddContainerSubclass

constexpr auto AZ::DocumentPropertyEditor::Nodes::Adapter::AddContainerSubclass
staticconstexpr
Initial value:
=
CallbackAttributeDefinition<void(const AZ::SerializeContext::ClassData*, AZ::Dom::Path)>("AddContainerSubclass")

◆ QuerySubclass

constexpr auto AZ::DocumentPropertyEditor::Nodes::Adapter::QuerySubclass
staticconstexpr
Initial value:
=
CallbackAttributeDefinition<void(AZStd::shared_ptr<AZStd::vector<const AZ::SerializeContext::ClassData*>>*, AZ::Dom::Path)>(
"QuerySubclass")

◆ SetNodeDisabled

constexpr auto AZ::DocumentPropertyEditor::Nodes::Adapter::SetNodeDisabled
staticconstexpr
Initial value:
=
CallbackAttributeDefinition<void(bool shouldDisable, Dom::Path targetNode)>("SetDisabled")

Use this callback attribute if there is need to enable/disable an adapter's nodes at runtime.


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