Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Static Public Attributes | List of all members
AZ::DocumentPropertyEditor::Nodes::PropertyEditor Struct Reference

#include <PropertyEditorNodes.h>

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

Inherited by AZ::DocumentPropertyEditor::Nodes::UIElement.

Public Types

enum class  Align : AZ::u8 { AlignLeft , AlignRight , AlignCenter , UseDefaultAlignment }
 Specifies the alignment options for a PropertyEditor that has the Alignment attribute.
 

Static Public Attributes

static constexpr AZStd::string_view Name = "PropertyEditor"
 
static constexpr auto Description = AttributeDefinition<AZStd::string_view>("Description")
 
static constexpr auto Type = AttributeDefinition<AZStd::string_view>("Type")
 
static constexpr auto OnChanged = CallbackAttributeDefinition<void(const Dom::Value&, ValueChangeType)>("OnChanged")
 
static constexpr auto Value = AttributeDefinition<AZ::Dom::Value>("Value")
 
static constexpr auto ValueType = TypeIdAttributeDefinition("ValueType")
 
static constexpr auto ValueHashed = AttributeDefinition<AZ::u64>("ValueHashed")
 
static constexpr auto ParentValue = AttributeDefinition<AZ::Dom::Value>("ParentValue")
 
static constexpr auto SharePriorColumn = AttributeDefinition<bool>("SharePriorColumn")
 
static constexpr auto UseMinimumWidth = AttributeDefinition<bool>("UseMinimumWidth")
 
static constexpr auto Alignment = AttributeDefinition<Align>("Alignment")
 
static constexpr auto EnumType = TypeIdAttributeDefinition("EnumType")
 
static constexpr auto EnumUnderlyingType = TypeIdAttributeDefinition("EnumUnderlyingType")
 
template<typename GenericValueType >
static constexpr auto GenericValue = GenericValueAttributeDefinition<GenericValueType>("GenericValue")
 
template<typename GenericValueType >
static constexpr auto GenericValueList = GenericValueListAttributeDefinition<GenericValueType>("GenericValueList")
 
static constexpr auto ChangeNotify = CallbackAttributeDefinition<PropertyRefreshLevel()>("ChangeNotify")
 
static constexpr auto ChangeValidate = CallbackAttributeDefinition<AZ::Outcome<void, AZStd::string>(void*, const AZ::Uuid&)>("ChangeValidate")
 
static constexpr auto RequestTreeUpdate = CallbackAttributeDefinition<void(PropertyRefreshLevel)>("RequestTreeUpdate")
 
- 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>"
 

Additional Inherited Members

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

Detailed Description

PropertyEditor: A property editor, of a type dictated by its "type" field, that can edit an associated value.

Member Data Documentation

◆ Alignment

constexpr auto AZ::DocumentPropertyEditor::Nodes::PropertyEditor::Alignment = AttributeDefinition<Align>("Alignment")
staticconstexpr

Specifies that this PropertyEditor should have a specific alignment within its own column. The alignment of ALL PropertyEditors inside of a SharedColumn will be the alignment of the last PropertyEditor with a valid alignment attribute.

◆ SharePriorColumn

constexpr auto AZ::DocumentPropertyEditor::Nodes::PropertyEditor::SharePriorColumn = AttributeDefinition<bool>("SharePriorColumn")
staticconstexpr

If set to true, specifies that this PropertyEditor shouldn't be allocated its own column, but instead appended to the previous column in the layout, creating a SharedColumn that can hold many PropertyEditors. Useful for things like the "add container entry" button.

◆ UseMinimumWidth

constexpr auto AZ::DocumentPropertyEditor::Nodes::PropertyEditor::UseMinimumWidth = AttributeDefinition<bool>("UseMinimumWidth")
staticconstexpr

DEPENDENT attribute - must be used inside a SharedColumn. If set to true, specifies that this PropertyEditor should only take up as much space as its minimum width. Useful for placing things like "add container entry" and "remove all elements" next to each other

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