Class: QgsSettingsEntryGroup

Creates a group of settings which have a common definition of base key.

Added in version 3.26.

Deprecated since version 3.30: Use QgsSettingsTreeNode instead.

class qgis.core.QgsSettingsEntryGroup

Bases: object

__init__(settings: Iterable[QgsSettingsEntryBase])

Constructor

Parameters:

settings (Iterable[QgsSettingsEntryBase])

__init__(a0: QgsSettingsEntryGroup)

Parameters:

a0 (QgsSettingsEntryGroup)

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

Returns the base key for the given dynamicKeyPartList

Parameters:

dynamicKeyPartList (Iterable[Optional[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 | None = '')

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

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

Parameters:

dynamicKeyPart (Optional[str] = '')

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

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[Optional[str]] = [])

settings(self) → List[QgsSettingsEntryBase]

Returns all the settings

Return type:

List[QgsSettingsEntryBase]