#include <BasicAdapter.h>

Inherits AZ::DocumentPropertyEditor::DocumentAdapter.

Public Member Functions
void	SetContents (Dom::Value contents)
	Resets the contents of this adapter with a new DOM.

Dom::PatchOutcome	RequestContentChange (const Dom::Patch &patch)

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())

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

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)

Detailed Description

BasicAdapter is a DocumentAdapter that simply provides a fixed DOM provided by a call to SetContents. The consumer is responsible for listening to change and reset events and handling them accordingly to provide interactivity.

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

Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/BasicAdapter.h

Public Member Functions

Additional Inherited Members

Detailed Description