Class: QgsSettingsEntryGroup

class qgis.core.QgsSettingsEntryGroup

Bases: sip.wrapper

Creates a group of setting which have a common definition of base key

New in version 3.26.

QgsSettingsEntryGroup(settings: Iterable[QgsSettingsEntryBase]) Constructor

QgsSettingsEntryGroup(QgsSettingsEntryGroup)

Methods

baseKey

Returns the base key for the given dynamicKeyPartList

isValid

Returns if the group is valid (if settings share the same base key)

removeAllChildrenSettings

Removes all the settings from this group The dynamicKeyPart argument specifies the dynamic part of the settings key.

removeAllSettingsAtBaseKey

Removes all the settings at the base key for the given dynamicKeyPartList This means it might remove more settings than the ones registered in the group, use with caution

settings

Returns all the settings

baseKey(self, dynamicKeyPartList: Iterable[str] = []) str

Returns the base key for the given dynamicKeyPartList

Parameters:

dynamicKeyPartList (Iterable[str] = []) –

Return type:

str

isValid(self) bool

Returns if the group is valid (if settings share the same base key)

Return type:

bool

removeAllChildrenSettings(self, dynamicKeyPart: str = '')

Removes all the settings from this group The dynamicKeyPart argument specifies the dynamic part of the settings key.

removeAllChildrenSettings(self, dynamicKeyPartList: Iterable[str]) Removes all the settings from this group The dynamicKeyPartList argument specifies the dynamic part of the settings key.

Parameters:

dynamicKeyPart (str = '') –

removeAllSettingsAtBaseKey(self, dynamicKeyPartList: Iterable[str] = [])

Removes all the settings at the base key for the given dynamicKeyPartList This means it might remove more settings than the ones registered in the group, use with caution

Parameters:

dynamicKeyPartList (Iterable[str] = []) –

settings(self) List[QgsSettingsEntryBase]

Returns all the settings

Return type:

List[QgsSettingsEntryBase]