Class: QgsSettingsRegistry

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

Added in version 3.20.

Deprecated since version 3.30: Use QgsSettings.treeRoot() instead.

Class Hierarchy

Subclasses

QgsSettingsRegistryCore	QgsSettingsRegistryCore is used for settings introspection and collects all QgsSettingsEntry instances of core.
QgsSettingsRegistryGui	QgsSettingsRegistryGui is used for settings introspection and collects all QgsSettingsEntry instances of gui.

Methods

addSettingsEntry	Adds settingsEntry to the registry.
addSettingsEntryGroup	Adds a group of setting to the registry
addSubRegistry	Append a child settingsRegistry to the register.
removeSubRegistry	Remove a child settingsRegistry from the register.
settingEntries	Returns the list of registered QgsSettingsEntryBase.
settingsEntry	Returns the QgsSettingsEntry with the given key or None if not found.
subRegistries	Returns the list of registered child QgsSettingsRegistry.

class qgis.core.QgsSettingsRegistry

Bases: object

addSettingsEntry(self, settingsEntry: QgsSettingsEntryBase | None) → bool

Adds settingsEntry to the registry.

Parameters:

settingsEntry (Optional[QgsSettingsEntryBase])

Return type:

bool

addSettingsEntryGroup(self, settingsGroup: QgsSettingsEntryGroup | None)

Adds a group of setting to the registry

Added in version 3.26.

Deprecated since version 3.30.

Parameters:

settingsGroup (Optional[QgsSettingsEntryGroup])

addSubRegistry(self, settingsRegistry: QgsSettingsRegistry | None)

Append a child settingsRegistry to the register.

Parameters:

settingsRegistry (Optional[QgsSettingsRegistry])

removeSubRegistry(self, settingsRegistry: QgsSettingsRegistry | None)

Remove a child settingsRegistry from the register.

Parameters:

settingsRegistry (Optional[QgsSettingsRegistry])

settingEntries(self) → List[QgsSettingsEntryBase]

Returns the list of registered QgsSettingsEntryBase.

Return type:

List[QgsSettingsEntryBase]

settingsEntry(self, key: str | None, searchChildRegistries: bool = True) → QgsSettingsEntryBase | None

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

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

Parameters:

• key (Optional[str])

• searchChildRegistries (bool = True)

Return type:

Optional[QgsSettingsEntryBase]

subRegistries(self) → List[QgsSettingsRegistry]

Returns the list of registered child QgsSettingsRegistry.

Return type:

List[QgsSettingsRegistry]