#include <CvarAdapter.h>

Inherits AZ::DocumentPropertyEditor::DocumentAdapter.

Public Member Functions
void	OnContentsChanged (const Dom::Path &path, const Dom::Value &value)

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

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

Detailed Description

An adapter for displaying an editable list of CVars registered to the console instance. Supports editing CVars with primitive types, string types, and numeric vector types (VectorX, Quaternion, and Color).

Member Function Documentation

◆ GenerateContents()

Dom::Value AZ::DocumentPropertyEditor::CvarAdapter::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.

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

Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/CvarAdapter.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GenerateContents()