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.
AZ::DocumentPropertyEditor::MetaAdapter Class Referenceabstract

Inherits AZ::DocumentPropertyEditor::DocumentAdapter.

Inherited by AZ::DocumentPropertyEditor::RowFilterAdapter, and AZ::DocumentPropertyEditor::RowSortAdapter.

Public Member Functions

void SetSourceAdapter (DocumentAdapterPtr sourceAdapter)
 
virtual Dom::Path MapFromSourcePath (const Dom::Path &sourcePath) const =0
 
virtual Dom::Path MapToSourcePath (const Dom::Path &filterPath) const =0
 
ExpanderSettingsCreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string()) override
 
- Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
 AZ_RTTI (DocumentAdapter, "{8CEFE485-45C2-4ECC-B9D1-BBE75C7B02AB}")
 
Dom::Value GetContents () const
 
void ConnectResetHandler (ResetEvent::Handler &handler)
 
void ConnectChangedHandler (ChangedEvent::Handler &handler)
 
void ConnectMessageHandler (MessageEvent::Handler &handler)
 
virtual void SetRouter (RoutingAdapter *router, const Dom::Path &route)
 
Dom::Value SendAdapterMessage (const AdapterMessage &message)
 
bool IsEmpty ()
 
virtual ExpanderSettingsCreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string())
 

Protected Member Functions

void HandleDomMessage (const AZ::DocumentPropertyEditor::AdapterMessage &message, Dom::Value &value)
 
virtual void HandleReset ()=0
 
virtual void HandleDomChange (const Dom::Patch &patch)=0
 
bool IsRow (const Dom::Path &sourcePath) const
 
Dom::Path GetRowPath (const Dom::Path &sourcePath) const
 returns the first path in the ancestry of sourcePath that is of type Row, including self
 
- Protected Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
virtual Dom::Value GenerateContents ()=0
 
virtual Dom::Value HandleMessage (const AdapterMessage &message)
 
void NotifyResetDocument (DocumentResetType resetType=DocumentResetType::SoftReset)
 
void NotifyContentsChanged (const Dom::Patch &patch)
 

Static Protected Member Functions

static bool IsRow (const Dom::Value &domValue)
 convenience method to determine whether a particular Dom Value is a row
 

Protected Attributes

DocumentAdapter::ResetEvent::Handler m_resetHandler
 
ChangedEvent::Handler m_changedHandler
 
MessageEvent::Handler m_domMessageHandler
 
DocumentAdapterPtr m_sourceAdapter
 

Additional Inherited Members

- Public Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
using ResetEvent = Event<>
 
using ChangedEvent = Event< const Dom::Patch & >
 
using MessageEvent = Event< const AdapterMessage &, Dom::Value & >
 
- Static Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
static bool IsDebugModeEnabled ()
 
static void SetDebugModeEnabled (bool enableDebugMode)
 
static bool IsRow (const Dom::Value &domValue)
 convenience method to determine whether a particular Dom Value is a row
 
- Protected Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
enum class  DocumentResetType { SoftReset , HardReset }
 Specifies the type of reset operation triggered in NotifyResetDocument. More...
 

Member Function Documentation

◆ CreateExpanderSettings()

ExpanderSettings * AZ::DocumentPropertyEditor::MetaAdapter::CreateExpanderSettings ( DocumentAdapter referenceAdapter,
const AZStd::string &  settingsRegistryKey = AZStd::string(),
const AZStd::string &  propertyEditorName = AZStd::string() 
)
overridevirtual

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