Class: QgsSettingsRegistry

class qgis.core.QgsSettingsRegistry

Bases: sip.wrapper

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

New in version 3.20.

QgsSettingsRegistry() Constructor for QgsSettingsRegistry.

QgsSettingsRegistry(QgsSettingsRegistry)

Methods

addSettingsEntry

Add settingsEntry to the register.

addSubRegistry

Append a child settingsRegistry to 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.

addSettingsEntry(self, settingsEntry: QgsSettingsEntryBase)

Add settingsEntry to the register.

Parameters

settingsEntry (QgsSettingsEntryBase) –

addSubRegistry(self, settingsRegistry: QgsSettingsRegistry)

Append a child settingsRegistry to the register.

Parameters

settingsRegistry (QgsSettingsRegistry) –

settingEntries(self)List[QgsSettingsEntryBase]

Returns the list of registered QgsSettingsEntryBase.

Return type

List[QgsSettingsEntryBase]

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

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 (str) –

  • searchChildRegistries (bool = True) –

Return type

QgsSettingsEntryBase

subRegistries(self)List[QgsSettingsRegistry]

Returns the list of registered child QgsSettingsRegistry.

Return type

List[QgsSettingsRegistry]