QGIS API Documentation  3.27.0-Master (11ef3e5184)
Public Member Functions | List of all members
QgsSettingsEntryGroup Class Reference

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

#include <qgssettingsentry.h>

Public Member Functions

 QgsSettingsEntryGroup (const QList< const QgsSettingsEntryBase * > settings)
 Constructor. More...
 
 QgsSettingsEntryGroup (const QList< const QgsSettingsEntryBase * > settings, bool fatalErrorIfInvalid)
 Constructor. More...
 
QString baseKey (const QStringList &dynamicKeyPartList=QStringList()) const
 Returns the base key for the given dynamicKeyPartList. More...
 
bool isValid () const
 Returns if the group is valid (if settings share the same base key) More...
 
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. More...
 
void removeAllChildrenSettings (const QStringList &dynamicKeyPartList) const
 Removes all the settings from this group The dynamicKeyPartList argument specifies the dynamic part of the settings key. More...
 
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. More...
 
const QList< const QgsSettingsEntryBase * > settings () const
 Returns all the settings. More...
 

Detailed Description

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

Since
QGIS 3.26

Definition at line 38 of file qgssettingsentry.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryGroup() [1/2]

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

Constructor.

Definition at line 42 of file qgssettingsentry.h.

◆ QgsSettingsEntryGroup() [2/2]

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

Constructor.

Definition at line 24 of file qgssettingsentry.cpp.

Member Function Documentation

◆ baseKey()

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

Returns the base key for the given dynamicKeyPartList.

Definition at line 48 of file qgssettingsentry.cpp.

◆ isValid()

bool QgsSettingsEntryGroup::isValid ( ) const
inline

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

Definition at line 58 of file qgssettingsentry.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 91 of file qgssettingsentry.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 96 of file qgssettingsentry.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 76 of file qgssettingsentry.cpp.

◆ settings()

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

Returns all the settings.

Definition at line 64 of file qgssettingsentry.h.


The documentation for this class was generated from the following files: