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

virtual	~QgsSettingsRegistry ()
	Destructor for QgsSettingsRegistry. More...

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

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

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

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

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

Protected Member Functions
void	addSettingsEntry (const QgsSettingsEntryBase *settingsEntry)
	Add settingsEntry to the register. More...

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

Definition at line 34 of file qgssettingsregistry.h.

Constructor & Destructor Documentation

◆ QgsSettingsRegistry()

QgsSettingsRegistry::QgsSettingsRegistry ( )

Constructor for QgsSettingsRegistry.

Definition at line 28 of file qgssettingsregistry.cpp.

◆ ~QgsSettingsRegistry()

QgsSettingsRegistry::~QgsSettingsRegistry ( )

virtual

Destructor for QgsSettingsRegistry.

Definition at line 34 of file qgssettingsregistry.cpp.

Member Function Documentation

◆ addSettingsEntry()

void QgsSettingsRegistry::addSettingsEntry ( const QgsSettingsEntryBase * settingsEntry )

protected

Add settingsEntry to the register.

Definition at line 38 of file qgssettingsregistry.cpp.

◆ addSubRegistry()

void QgsSettingsRegistry::addSubRegistry ( const QgsSettingsRegistry * settingsRegistry )

Append a child settingsRegistry to the register.

Definition at line 84 of file qgssettingsregistry.cpp.

◆ removeSubRegistry()

void QgsSettingsRegistry::removeSubRegistry ( const QgsSettingsRegistry * settingsRegistry )

Remove a child settingsRegistry from the register.

Definition at line 101 of file qgssettingsregistry.cpp.

◆ settingEntries()

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

Returns the list of registered QgsSettingsEntryBase.

Definition at line 55 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 60 of file qgssettingsregistry.cpp.

◆ subRegistries()

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

Returns the list of registered child QgsSettingsRegistry.

Definition at line 118 of file qgssettingsregistry.cpp.

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

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

Public Member Functions

Protected Member Functions