QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
A string list settings entry. More...
#include <qgssettingsentry.h>
Public Member Functions | |
QgsSettingsEntryStringList (const QString &key, const QString &pluginName, const QStringList &defaultValue=QStringList(), const QString &description=QString()) | |
Constructor for QgsSettingsEntryStringList. More... | |
QgsSettingsEntryStringList (const QString &key, QgsSettings::Section section, const QStringList &defaultValue=QStringList(), const QString &description=QString()) | |
Constructor for QgsSettingsEntryStringList. More... | |
QStringList | defaultValue () const |
Returns settings default value. More... | |
virtual SettingsType | settingsType () const override |
Returns the settings entry type. More... | |
bool | setValue (const QStringList &value, const QString &dynamicKeyPart=QString()) const |
Set settings value. More... | |
bool | setValue (const QStringList &value, const QStringList &dynamicKeyPartList) const |
Set settings value. More... | |
QStringList | value (const QString &dynamicKeyPart=QString(), bool useDefaultValueOverride=false, const QStringList &defaultValueOverride=QStringList()) const |
Returns settings value. More... | |
QStringList | value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride=false, const QStringList &defaultValueOverride=QStringList()) const |
Returns settings value. More... | |
Public Member Functions inherited from QgsSettingsEntryBase | |
QgsSettingsEntryBase (const QString &key, const QString &pluginName, const QVariant &defaultValue=QVariant(), const QString &description=QString()) | |
Constructor for QgsSettingsEntryBase. More... | |
QgsSettingsEntryBase (const QString &key, QgsSettings::Section section, const QVariant &defaultValue=QVariant(), const QString &description=QString()) | |
Constructor for QgsSettingsEntryBase. More... | |
virtual | ~QgsSettingsEntryBase () |
Destructor for QgsSettingsEntryBase. More... | |
QVariant | defaultValueAsVariant () const |
Returns settings default value. More... | |
QString | definitionKey () const |
Returns settings entry defining key. More... | |
QString | description () const |
Returns the settings entry description. More... | |
bool | exists (const QString &dynamicKeyPart=QString()) const |
Returns true if the settings is contained in the underlying QSettings. More... | |
bool | exists (const QStringList &dynamicKeyPartList) const |
Returns true if the settings is contained in the underlying QSettings. More... | |
bool | hasDynamicKey () const |
Returns true if a part of the settings key is built dynamically. More... | |
QString | key (const QString &dynamicKeyPart=QString()) const |
Returns settings entry key. More... | |
QString | key (const QStringList &dynamicKeyPartList) const |
Returns settings entry key. More... | |
bool | keyIsValid (const QString &key) const |
Returns true if the provided key match the settings entry. More... | |
void | remove (const QString &dynamicKeyPart=QString()) const |
Removes the settings from the underlying QSettings. More... | |
void | remove (const QStringList &dynamicKeyPartList) const |
Removes the settings from the underlying QSettings. More... | |
QgsSettings::Section | section () const |
Returns settings section. More... | |
virtual bool | setVariantValue (const QVariant &value, const QString &dynamicKeyPart=QString()) const |
Set settings value. More... | |
virtual bool | setVariantValue (const QVariant &value, const QStringList &dynamicKeyPartList) const |
Set settings value. More... | |
QVariant | valueAsVariant (const QString &dynamicKeyPart=QString(), bool useDefaultValueOverride=false, const QVariant &defaultValueOverride=QVariant()) const |
Returns settings value. More... | |
QVariant | valueAsVariant (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride=false, const QVariant &defaultValueOverride=QVariant()) const |
Returns settings value. More... | |
Additional Inherited Members | |
Public Types inherited from QgsSettingsEntryBase | |
enum class | SettingsType : int { Variant , String , StringList , Bool , Integer , Double , EnumFlag , Color } |
Types of settings entries. More... | |
QgsSettingsEntryStringList::QgsSettingsEntryStringList | ( | const QString & | key, |
QgsSettings::Section | section, | ||
const QStringList & | defaultValue = QStringList() , |
||
const QString & | description = QString() |
||
) |
Constructor for QgsSettingsEntryStringList.
The key argument specifies the final part of the settings key. The section argument specifies the section. The defaultValue argument specifies the default value for the settings entry. The description argument specifies a description for the settings entry.
Definition at line 363 of file qgssettingsentry.cpp.
QgsSettingsEntryStringList::QgsSettingsEntryStringList | ( | const QString & | key, |
const QString & | pluginName, | ||
const QStringList & | defaultValue = QStringList() , |
||
const QString & | description = QString() |
||
) |
Constructor for QgsSettingsEntryStringList.
This constructor is intended to be used from plugins.
The key argument specifies the key of the settings. The pluginName argument is inserted in the key after the section. The defaultValue argument specifies the default value for the settings entry. The description argument specifies a description for the settings entry.
Definition at line 371 of file qgssettingsentry.cpp.
QStringList QgsSettingsEntryStringList::defaultValue | ( | ) | const |
Returns settings default value.
Definition at line 399 of file qgssettingsentry.cpp.
|
overridevirtual |
Returns the settings entry type.
Implements QgsSettingsEntryBase.
Definition at line 404 of file qgssettingsentry.cpp.
bool QgsSettingsEntryStringList::setValue | ( | const QStringList & | value, |
const QString & | dynamicKeyPart = QString() |
||
) | const |
Set settings value.
The value to set. The dynamicKeyPart argument specifies the dynamic part of the settings key.
Definition at line 379 of file qgssettingsentry.cpp.
bool QgsSettingsEntryStringList::setValue | ( | const QStringList & | value, |
const QStringList & | dynamicKeyPartList | ||
) | const |
Set settings value.
The value to set. The dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
Definition at line 384 of file qgssettingsentry.cpp.
QStringList QgsSettingsEntryStringList::value | ( | const QString & | dynamicKeyPart = QString() , |
bool | useDefaultValueOverride = false , |
||
const QStringList & | defaultValueOverride = QStringList() |
||
) | const |
Returns settings value.
The dynamicKeyPart argument specifies the dynamic part of the settings key. The useDefaultValueOverride argument specifies if defaultValueOverride should be used. The defaultValueOverride argument if valid is used instead of the normal default value.
Definition at line 389 of file qgssettingsentry.cpp.
QStringList QgsSettingsEntryStringList::value | ( | const QStringList & | dynamicKeyPartList, |
bool | useDefaultValueOverride = false , |
||
const QStringList & | defaultValueOverride = QStringList() |
||
) | const |
Returns settings value.
The dynamicKeyParts argument specifies the list of dynamic parts of the settings key. The useDefaultValueOverride argument specifies if defaultValueOverride should be used. The defaultValueOverride argument if valid is used instead of the normal default value.
Definition at line 394 of file qgssettingsentry.cpp.