AZ::DocumentPropertyEditor::SettingsRegistryAdapter Class Reference

Inherits AZ::DocumentPropertyEditor::DocumentAdapter.

Classes
struct	SettingsRegistryDomData

Public Member Functions
	SettingsRegistryAdapter ()
	SettingsRegistryAdapter (AZ::SettingsRegistryOriginTracker *originTracker)
	Constructs a Settings Registry adapter using the supplied SettingsRegistry Origin Tracker instance.
bool	BuildField (AZStd::string_view path, AZStd::string_view fieldName, AZ::SettingsRegistryInterface::SettingsType type)
SettingsRegistryOriginTracker *	GetSettingsRegistryOriginTracker ()
const SettingsRegistryOriginTracker *	GetSettingsRegistryOriginTracker () const
bool	BuildBool (AZStd::string_view path)
bool	BuildInt64 (AZStd::string_view path)
bool	BuildUInt64 (AZStd::string_view path)
bool	BuildFloat (AZStd::string_view path)
bool	BuildString (AZStd::string_view path)
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 ExpanderSettings *	CreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string())

Protected Member Functions
Dom::Value	GenerateContents () override
Dom::Value	HandleMessage (const AdapterMessage &message) override
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)

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...

Constructor & Destructor Documentation

SettingsRegistryAdapter()

AZ::DocumentPropertyEditor::SettingsRegistryAdapter::SettingsRegistryAdapter

(

)

Default constructs a Settings Registry adapter that uses the globally registered SettingsRegistryOriginTracker instance

Member Function Documentation

GenerateContents()

Dom::Value AZ::DocumentPropertyEditor::SettingsRegistryAdapter::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::SettingsRegistryAdapter::HandleMessage ( const AdapterMessage &  message )

overrideprotectedvirtual

Called by SendAdapterMessage before the view is notified. This may be overridden to handle BoundAdapterMessages on fields.

Reimplemented from AZ::DocumentPropertyEditor::DocumentAdapter.

---

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

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