#include <ReflectionAdapter.h>
Inherits AZ::DocumentPropertyEditor::RoutingAdapter.
|
using | PropertyChangeEvent = Event<const PropertyChangeInfo&> |
|
using | ResetEvent = Event<> |
|
using | ChangedEvent = Event<const Dom::Patch&> |
|
using | MessageEvent = Event<const AdapterMessage&, Dom::Value&> |
|
|
struct | ReflectionAdapterReflectionImpl |
|
ReflectionAdapter turns an in-memory instance of an object backed by the AZ Reflection system (via SerializeContext & EditContext) and creates a property grid that supports editing its members in a manner outlined by its reflection data.
◆ ReflectionAdapter()
AZ::DocumentPropertyEditor::ReflectionAdapter::ReflectionAdapter |
( |
void * | instance, |
|
|
AZ::TypeId | typeId ) |
◆ ConnectPropertyChangeHandler()
void AZ::DocumentPropertyEditor::ReflectionAdapter::ConnectPropertyChangeHandler |
( |
PropertyChangeEvent::Handler & | handler | ) |
|
Connects a listener to the event fired when a property has been changed. This can be used to notify the view of changes to the DOM, e.g. notifying an editor of document changes.
◆ CreateExpanderSettings()
ExpanderSettings * AZ::DocumentPropertyEditor::ReflectionAdapter::CreateExpanderSettings |
( |
DocumentAdapter * | referenceAdapter, |
|
|
const AZStd::string & | settingsRegistryKey = AZStd::string(), |
|
|
const AZStd::string & | propertyEditorName = AZStd::string() ) |
|
overridevirtual |
◆ CreateLabel()
virtual void AZ::DocumentPropertyEditor::ReflectionAdapter::CreateLabel |
( |
AdapterBuilder * | adapterBuilder, |
|
|
AZStd::string_view | labelText, |
|
|
AZStd::string_view | serializedPath ) |
|
virtual |
Creates a node for displaying label information. Subclass adapter can override the default behavior.
- Parameters
-
adapterBuilder | The adapter builder currently being used by this adapter. |
labelText | The text string to be displayed in label. |
serializedPath | The serialized path fetched from AZ::Reflection::DescriptorAttributes. |
◆ GenerateContents()
Dom::Value AZ::DocumentPropertyEditor::ReflectionAdapter::GenerateContents |
( |
| ) |
|
|
overrideprotectedvirtual |
Generates the contents of this adapter. This must be an Adapter DOM node. These contents will be cached - to notify clients of changes to the structure, NotifyResetDocument or NotifyContentsChanged must be used.
- See also
- AdapterBuilder for building out this DOM structure.
Implements AZ::DocumentPropertyEditor::DocumentAdapter.
◆ HandleMessage()
Dom::Value AZ::DocumentPropertyEditor::ReflectionAdapter::HandleMessage |
( |
const AdapterMessage & | message | ) |
|
|
overrideprotectedvirtual |
◆ InvokeChangeNotify()
static void AZ::DocumentPropertyEditor::ReflectionAdapter::InvokeChangeNotify |
( |
const AZ::Dom::Value & | domNode | ) |
|
|
static |
Invokes the ChangeNotify attribute for an Adapter, if present, and follows up with a tree refresh if needed.
◆ NotifyPropertyChanged()
void AZ::DocumentPropertyEditor::ReflectionAdapter::NotifyPropertyChanged |
( |
const PropertyChangeInfo & | changeInfo | ) |
|
Call this to trigger a PropertyChangeEvent to notify the view that one of this adapter's property editor instances has altered its value.
◆ SetValue()
void AZ::DocumentPropertyEditor::ReflectionAdapter::SetValue |
( |
void * | instance, |
|
|
AZ::TypeId | typeId ) |
Sets the instance to reflect. If typeId is a type registered to SerializeContext, this adapter will produce a property grid based on its contents.
◆ UpdateDomContents()
virtual void AZ::DocumentPropertyEditor::ReflectionAdapter::UpdateDomContents |
( |
const PropertyChangeInfo & | propertyChangeInfo | ) |
|
|
virtual |
Updates the contents of adapter Dom contents using the property change information provided. Child adapters can override this function to make more changes to the Dom in addition to the property changes.
- Parameters
-
propertyChangeInfo | Object containing information about the property change. |
The documentation for this class was generated from the following file:
- Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/ReflectionAdapter.h