Detailed Description

Settings interface to store and load settings like preferences.

Public Types
using	RESTRICT_DICTIONARY_PROPS = APPSETTINGS::RESTRICT

Public Member Functions
MAXON_METHOD ACCESSLEVEL	GetAccessLevel () const

MAXON_METHOD SettingsRef	GetParentSettings () const

MAXON_METHOD Result< DataDictionary >	GetSettingsCopy (const HashSet< Id > &optionalList, ACCESSLEVEL accessLevel=ACCESSLEVEL::ALL) const

	MAXON_OBSERVABLE_STATIC (void, ObservableSettingsChanged,(const ACCESSLEVEL &accessLevel, const HashSet< Id > &changedProperties), ObservableCombinerRunAllComponent)

Static Public Member Functions
static MAXON_METHOD SettingsRef	GetSettings (ACCESSLEVEL accessLevel=ACCESSLEVEL::ALL)

Private Member Functions
	MAXON_INTERFACE (SettingsInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.settingsinterface")

Member Typedef Documentation

◆ RESTRICT_DICTIONARY_PROPS

using RESTRICT_DICTIONARY_PROPS = APPSETTINGS::RESTRICT

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE	(	SettingsInterface	,
		MAXON_REFERENCE_NORMAL	,
		"net.maxon.interface.settingsinterface"
	)

private

◆ GetAccessLevel()

MAXON_METHOD ACCESSLEVEL GetAccessLevel ( ) const

GetAccessLevel returns the current level of this object.

◆ GetParentSettings()

MAXON_METHOD SettingsRef GetParentSettings ( ) const

GetParentSettings returns the SettingsRef from which settings are inherited.

◆ GetSettingsCopy()

MAXON_METHOD Result<DataDictionary> GetSettingsCopy	(	const HashSet< Id > &	optionalList,
		ACCESSLEVEL	accessLevel = `ACCESSLEVEL::ALL`
	)		const

GetSettingsCopy returns a copy of all settings starting at the given level.

Parameters

[in]	optionalList	Optional list of ids of interest. If empty, everything is returned.
[in]	accessLevel	Unused (for future extensions).

Returns: OK on success.

◆ GetSettings()

static MAXON_METHOD SettingsRef GetSettings ( ACCESSLEVEL accessLevel = ACCESSLEVEL::ALL )

static

GetSettings returns all settings on the current access level (see order above ACCESSLEVEL). The settings contain all inherited settings from lower levels.

Parameters

[in] accessLevel ACCESSLEVEL to ask for.

Returns: SettingsRef on success.

◆ MAXON_OBSERVABLE_STATIC()

MAXON_OBSERVABLE_STATIC	(	void	,
		ObservableSettingsChanged	,
		(const ACCESSLEVEL &accessLevel, const HashSet< Id > &changedProperties)	,
		ObservableCombinerRunAllComponent
	)