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

#include <qgssettingsentrygroup.h>

Public Member Functions
	QgsSettingsEntryGroup (QList< const QgsSettingsEntryBase * > settings)
	Constructor.

	QgsSettingsEntryGroup (QList< const QgsSettingsEntryBase * > settings, bool fatalErrorIfInvalid)
	Constructor.

QString	baseKey (const QStringList &dynamicKeyPartList=QStringList()) const
	Returns the base key for the given dynamicKeyPartList.

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

void	removeAllChildrenSettings (const QString &dynamicKeyPart=QString()) const
	Removes all the settings from this group The dynamicKeyPart argument specifies the dynamic part of the settings key.

void	removeAllChildrenSettings (const QStringList &dynamicKeyPartList) const
	Removes all the settings from this group The dynamicKeyPartList argument specifies the dynamic part of the settings key.

void	removeAllSettingsAtBaseKey (const QStringList &dynamicKeyPartList=QStringList()) const
	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.

const QList< const QgsSettingsEntryBase * >	settings () const
	Returns all the settings.

Detailed Description

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

Since: QGIS 3.26

Deprecated:: QGIS 3.30. Use QgsSettingsTreeNode instead.

Definition at line 38 of file qgssettingsentrygroup.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryGroup() [1/2]

QgsSettingsEntryGroup::QgsSettingsEntryGroup ( QList< const QgsSettingsEntryBase * > settings )

Constructor.

Definition at line 25 of file qgssettingsentrygroup.cpp.

◆ QgsSettingsEntryGroup() [2/2]

QgsSettingsEntryGroup::QgsSettingsEntryGroup	(	QList< const QgsSettingsEntryBase * >	settings,
		bool	fatalErrorIfInvalid
	)

Constructor.

Definition at line 31 of file qgssettingsentrygroup.cpp.

Member Function Documentation

◆ baseKey()

QString QgsSettingsEntryGroup::baseKey ( const QStringList & dynamicKeyPartList = QStringList() ) const

Returns the base key for the given dynamicKeyPartList.

Definition at line 55 of file qgssettingsentrygroup.cpp.

◆ isValid()

bool QgsSettingsEntryGroup::isValid ( ) const

inline

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

Definition at line 56 of file qgssettingsentrygroup.h.

◆ removeAllChildrenSettings() [1/2]

void QgsSettingsEntryGroup::removeAllChildrenSettings ( const QString & dynamicKeyPart = QString() ) const

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

Definition at line 98 of file qgssettingsentrygroup.cpp.

◆ removeAllChildrenSettings() [2/2]

void QgsSettingsEntryGroup::removeAllChildrenSettings ( const QStringList & dynamicKeyPartList ) const

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

Definition at line 103 of file qgssettingsentrygroup.cpp.

◆ removeAllSettingsAtBaseKey()

void QgsSettingsEntryGroup::removeAllSettingsAtBaseKey ( const QStringList & dynamicKeyPartList = QStringList() ) const

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.

Definition at line 83 of file qgssettingsentrygroup.cpp.

◆ settings()

const QList< const QgsSettingsEntryBase * > QgsSettingsEntryGroup::settings ( ) const