QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
A color settings entry. More...
#include <qgssettingsentry.h>
Public Member Functions | |
QgsSettingsEntryColor (const QString &key, const QString &pluginName, const QColor &defaultValue=QColor(), const QString &description=QString()) | |
Constructor for QgsSettingsEntryColor. More... | |
QgsSettingsEntryColor (const QString &key, QgsSettings::Section section, const QColor &defaultValue=QColor(), const QString &description=QString()) | |
Constructor for QgsSettingsEntryColor. More... | |
QColor | defaultValue () const |
Returns settings default value. More... | |
virtual SettingsType | settingsType () const override |
Returns the settings entry type. More... | |
bool | setValue (const QColor &value, const QString &dynamicKeyPart=QString()) const |
Set settings value. More... | |
bool | setValue (const QColor &value, const QStringList &dynamicKeyPartList) const |
Set settings value. More... | |
QColor | value (const QString &dynamicKeyPart=QString(), bool useDefaultValueOverride=false, const QString &defaultValueOverride=QString()) const |
Returns settings value. More... | |
QColor | value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride=false, const QString &defaultValueOverride=QString()) 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... | |
QgsSettingsEntryColor::QgsSettingsEntryColor | ( | const QString & | key, |
QgsSettings::Section | section, | ||
const QColor & | defaultValue = QColor() , |
||
const QString & | description = QString() |
||
) |
Constructor for QgsSettingsEntryColor.
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 651 of file qgssettingsentry.cpp.
QgsSettingsEntryColor::QgsSettingsEntryColor | ( | const QString & | key, |
const QString & | pluginName, | ||
const QColor & | defaultValue = QColor() , |
||
const QString & | description = QString() |
||
) |
Constructor for QgsSettingsEntryColor.
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 659 of file qgssettingsentry.cpp.
QColor QgsSettingsEntryColor::defaultValue | ( | ) | const |
Returns settings default value.
Definition at line 691 of file qgssettingsentry.cpp.
|
overridevirtual |
Returns the settings entry type.
Implements QgsSettingsEntryBase.
Definition at line 696 of file qgssettingsentry.cpp.
bool QgsSettingsEntryColor::setValue | ( | const QColor & | 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 667 of file qgssettingsentry.cpp.
bool QgsSettingsEntryColor::setValue | ( | const QColor & | 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 676 of file qgssettingsentry.cpp.
QColor QgsSettingsEntryColor::value | ( | const QString & | dynamicKeyPart = QString() , |
bool | useDefaultValueOverride = false , |
||
const QString & | defaultValueOverride = QString() |
||
) | 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 681 of file qgssettingsentry.cpp.
QColor QgsSettingsEntryColor::value | ( | const QStringList & | dynamicKeyPartList, |
bool | useDefaultValueOverride = false , |
||
const QString & | defaultValueOverride = QString() |
||
) | 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 686 of file qgssettingsentry.cpp.