QgsSettingsRegistry is used for settings introspection and collects a list of child QgsSettingsRegistry and a list of child QgsSettingsRegistry. More...

#include <qgssettingsregistry.h>

Inheritance diagram for QgsSettingsRegistry:

[legend]

Public Member Functions
	QgsSettingsRegistry ()
	Constructor for QgsSettingsRegistry.

virtual	~QgsSettingsRegistry ()
	Destructor for QgsSettingsRegistry.

void	addSubRegistry (const QgsSettingsRegistry *settingsRegistry)
	Append a child settingsRegistry to the register.

void	removeSubRegistry (const QgsSettingsRegistry *settingsRegistry)
	Remove a child settingsRegistry from the register.

QList< const QgsSettingsEntryBase * >	settingEntries () const
	Returns the list of registered QgsSettingsEntryBase.

const QgsSettingsEntryBase *	settingsEntry (const QString &key, bool searchChildRegistries=true) const
	Returns the QgsSettingsEntry with the given key or nullptr if not found.

QList< const QgsSettingsRegistry * >	subRegistries () const
	Returns the list of registered child QgsSettingsRegistry.

Protected Member Functions
bool	addSettingsEntry (const QgsSettingsEntryBase *settingsEntry)
	Adds settingsEntry to the registry.

Q_DECL_DEPRECATED void	addSettingsEntryGroup (const QgsSettingsEntryGroup *settingsGroup)
	Adds a group of setting to the registry.

Friends
class	QgsSettingsEntryBase

Detailed Description

QgsSettingsRegistry is used for settings introspection and collects a list of child QgsSettingsRegistry and a list of child QgsSettingsRegistry.

Since: QGIS 3.20

Deprecated:: since QGIS 3.30 use QgsSettings::treeRoot() instead

Definition at line 38 of file qgssettingsregistry.h.

Constructor & Destructor Documentation

◆ QgsSettingsRegistry()

QgsSettingsRegistry::QgsSettingsRegistry ( )

Constructor for QgsSettingsRegistry.

Definition at line 21 of file qgssettingsregistry.cpp.

◆ ~QgsSettingsRegistry()

QgsSettingsRegistry::~QgsSettingsRegistry ( )

virtual

Destructor for QgsSettingsRegistry.

Definition at line 27 of file qgssettingsregistry.cpp.

Member Function Documentation

◆ addSettingsEntry()

bool QgsSettingsRegistry::addSettingsEntry ( const QgsSettingsEntryBase * settingsEntry )

protected

Adds settingsEntry to the registry.

Definition at line 31 of file qgssettingsregistry.cpp.

◆ addSettingsEntryGroup()

void QgsSettingsRegistry::addSettingsEntryGroup ( const QgsSettingsEntryGroup * settingsGroup )

protected

Adds a group of setting to the registry.

Since: QGIS 3.26

Deprecated:: since QGIS 3.30

Definition at line 49 of file qgssettingsregistry.cpp.

◆ addSubRegistry()

void QgsSettingsRegistry::addSubRegistry ( const QgsSettingsRegistry * settingsRegistry )

Append a child settingsRegistry to the register.

Definition at line 89 of file qgssettingsregistry.cpp.

◆ removeSubRegistry()

void QgsSettingsRegistry::removeSubRegistry ( const QgsSettingsRegistry * settingsRegistry )

Remove a child settingsRegistry from the register.

Definition at line 106 of file qgssettingsregistry.cpp.

◆ settingEntries()

QList< const QgsSettingsEntryBase * > QgsSettingsRegistry::settingEntries ( ) const

Returns the list of registered QgsSettingsEntryBase.

Definition at line 60 of file qgssettingsregistry.cpp.

◆ settingsEntry()

const QgsSettingsEntryBase * QgsSettingsRegistry::settingsEntry	(	const QString &	key,
		bool	searchChildRegistries = `true`
	)		const

Returns the QgsSettingsEntry with the given key or nullptr if not found.

The searchChildRegistries parameter specifies if child registries should be included in the search

Definition at line 65 of file qgssettingsregistry.cpp.

◆ subRegistries()

Q_NOWARN_DEPRECATED_PUSH QList< const QgsSettingsRegistry * > QgsSettingsRegistry::subRegistries ( ) const

Returns the list of registered child QgsSettingsRegistry.

Definition at line 124 of file qgssettingsregistry.cpp.

Friends And Related Symbol Documentation

◆ QgsSettingsEntryBase

friend class QgsSettingsEntryBase

friend

Definition at line 103 of file qgssettingsregistry.h.

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

/build/qgis-3.34.0+99sid/src/core/settings/qgssettingsregistry.h
/build/qgis-3.34.0+99sid/src/core/settings/qgssettingsregistry.cpp

Public Member Functions

Protected Member Functions

Friends