AZ::DocumentPropertyEditor::LabeledRowDPEExpanderSettings Class Reference

Inherits AZ::DocumentPropertyEditor::ExpanderSettings.

Public Member Functions
	LabeledRowDPEExpanderSettings (const AZ::DocumentPropertyEditor::DocumentAdapter *adapter=nullptr, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string())
Public Member Functions inherited from AZ::DocumentPropertyEditor::ExpanderSettings
	AZ_RTTI (ExpanderSettings, "{7DECB0A1-A1AB-41B2-B31F-E52D3C3014A6}")
	ExpanderSettings (const AZ::DocumentPropertyEditor::DocumentAdapter *adapter=nullptr, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string())
void	SetExpanderStateForRow (const AZ::Dom::Path &rowPath, bool isExpanded)
bool	GetExpanderStateForRow (const AZ::Dom::Path &rowPath)
bool	HasSavedExpanderStateForRow (const AZ::Dom::Path &rowPath) const
void	RemoveExpanderStateForRow (const AZ::Dom::Path &rowPath)
bool	WereSettingsLoaded () const
bool	ShouldEraseStateWhenRowRemoved () const
void	SetCleanExpanderStateCallback (CleanExpanderStateCallback function)

Protected Member Functions
PathType	GetStringPathForDomPath (const AZ::Dom::Path &rowPath) const override
Protected Member Functions inherited from AZ::DocumentPropertyEditor::ExpanderSettings
virtual PathType	GetStringPathForDomPath (const AZ::Dom::Path &rowPath) const
void	SaveExpanderStates ()
bool	LoadExpanderStates ()
void	SaveAndCleanExpanderStates ()

Additional Inherited Members
Public Types inherited from AZ::DocumentPropertyEditor::ExpanderSettings
using	PathType = AZ::IO::Path
using	ExpanderStateMap = AZStd::unordered_map< PathType, bool >
using	CleanExpanderStateCallback = AZStd::function< bool(ExpanderStateMap &)>
Static Public Member Functions inherited from AZ::DocumentPropertyEditor::ExpanderSettings
static void	Reflect (AZ::ReflectContext *context)
Public Attributes inherited from AZ::DocumentPropertyEditor::ExpanderSettings
ExpanderStateMap	m_expandedElementStates
	Serialized map of expanded element states.
Static Public Attributes inherited from AZ::DocumentPropertyEditor::ExpanderSettings
static constexpr const char *	RootSettingsFilepath = "user/Registry/DocumentPropertyEditor"
	Root filepath for DocumentPropertyEditor settings files.
static constexpr const char *	RootSettingsRegistryPath = "/O3DE/DocumentPropertyEditor"
	Root SettingsRegistry path where DPE settings are stored.
Protected Attributes inherited from AZ::DocumentPropertyEditor::ExpanderSettings
CleanExpanderStateCallback	m_cleanExpanderStateCallback
	Optional callback to clean locally stored state before saving.
bool	m_wereSettingsLoaded = false
bool	m_shouldSettingsPersist = false
bool	m_eraseStateWhenRowRemoved = false
SettingsRegistrar	m_settingsRegistrar
AZ::IO::Path	m_settingsFilepath
AZStd::string	m_fullSettingsRegistryPath
AZStd::string	m_settingsRegistryBasePath
const AZ::DocumentPropertyEditor::DocumentAdapter *	m_adapter

Constructor & Destructor Documentation

LabeledRowDPEExpanderSettings()

AZ::DocumentPropertyEditor::LabeledRowDPEExpanderSettings::LabeledRowDPEExpanderSettings	(	const AZ::DocumentPropertyEditor::DocumentAdapter *	adapter = nullptr,
		const AZStd::string &	settingsRegistryKey = AZStd::string(),
		const AZStd::string &	propertyEditorName = AZStd::string()
	)

Parameters

settingsRegistryKey

if settingsRegistryKey or propertyEditorName is empty, the expander state will only be stored in-memory (temporary)

Member Function Documentation

GetStringPathForDomPath()

PathType AZ::DocumentPropertyEditor::LabeledRowDPEExpanderSettings::GetStringPathForDomPath ( const AZ::Dom::Path &  rowPath ) const

overrideprotectedvirtual

Reimplemented from AZ::DocumentPropertyEditor::ExpanderSettings.

---

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

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