Class: QgsSettingsRegistry¶
- class qgis.core.QgsSettingsRegistry¶
Bases:
sip.wrapper
QgsSettingsRegistry
is used for settings introspection and collects a list of childQgsSettingsRegistry
and a list of childQgsSettingsRegistry
New in version 3.20.
Deprecated since version QGIS: 3.30 use
QgsSettings.treeRoot()
insteadQgsSettingsRegistry() Constructor for QgsSettingsRegistry.
QgsSettingsRegistry(
QgsSettingsRegistry
)Methods
Adds
settingsEntry
to the registry.Adds a group of setting to the registry
Append a child
settingsRegistry
to the register.Remove a child
settingsRegistry
from the register.Returns the list of registered
QgsSettingsEntryBase
.Returns the
QgsSettingsEntry
with the givenkey
or None if not found.Returns the list of registered child QgsSettingsRegistry.
- addSettingsEntry(self, settingsEntry: QgsSettingsEntryBase) bool ¶
Adds
settingsEntry
to the registry.- Parameters:
settingsEntry (QgsSettingsEntryBase) –
- Return type:
bool
- addSettingsEntryGroup(self, settingsGroup: QgsSettingsEntryGroup)¶
Adds a group of setting to the registry
New in version 3.26.
Deprecated since version QGIS: 3.30
- Parameters:
settingsGroup (QgsSettingsEntryGroup) –
- addSubRegistry(self, settingsRegistry: QgsSettingsRegistry)¶
Append a child
settingsRegistry
to the register.- Parameters:
settingsRegistry (QgsSettingsRegistry) –
- removeSubRegistry(self, settingsRegistry: QgsSettingsRegistry)¶
Remove a child
settingsRegistry
from 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 givenkey
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:
- subRegistries(self) List[QgsSettingsRegistry] ¶
Returns the list of registered child QgsSettingsRegistry.
- Return type:
List[QgsSettingsRegistry]