QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Base abstract class for settings entry which are passed by value. More...
#include <qgssettingsentry.h>
Public Member Functions | |
QgsSettingsEntryByValue (const QString &key, const QString §ion, QVariant defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
Constructor for QgsSettingsEntryByValue. More... | |
T | defaultValue () const |
Returns settings default value. More... | |
T | formerValue (const QString &dynamicKeyPart=QString()) const |
Returns the former value Returns the current value (or default) if there is no former value. More... | |
T | formerValue (const QStringList &dynamicKeyPartList) const |
Returns the former value Returns the current value (or default) if there is no former value. More... | |
virtual Qgis::SettingsType | settingsType () const override=0 |
Returns the settings entry type. More... | |
bool | setValue (T value, const QString &dynamicKeyPart=QString()) const |
Set settings value. More... | |
bool | setValue (T value, const QStringList &dynamicKeyPartList) const |
Set settings value. More... | |
Q_DECL_DEPRECATED T | value (const QString &dynamicKeyPart, bool useDefaultValueOverride, T defaultValueOverride) const |
Returns the settings value for the dynamicKeyPart and with a defaultValueOverride. More... | |
T | value (const QString &dynamicKeyPart=QString()) const |
Returns settings value. More... | |
T | value (const QStringList &dynamicKeyPartList) const |
Returns settings value. More... | |
Q_DECL_DEPRECATED T | value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, T defaultValueOverride) const |
Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride. More... | |
T | valueWithDefaultOverride (T defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. More... | |
T | valueWithDefaultOverride (T defaultValueOverride, const QStringList &dynamicKeyPartList) const |
Returns the settings value with a defaultValueOverride for the dynamicKeyPartList. More... | |
Public Member Functions inherited from QgsSettingsEntryBase | |
QgsSettingsEntryBase (const QString &key, const QString §ion, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
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... | |
QVariant | formerValueAsVariant (const QString &dynamicKeyPart) const |
Returns the former value of the settings if it has been enabled in the options. More... | |
QVariant | formerValueAsVariant (const QStringList &dynamicKeyPartList) const |
Returns the former value of the settings if it has been enabled in the options Returns the current value (or default) if there is no former value. 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... | |
Qgis::SettingsOptions | options () const |
Returns the settings options. 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... | |
Q_DECL_DEPRECATED QgsSettings::Section | section () const |
Returns settings section. More... | |
virtual Qgis::SettingsType | settingsType () const =0 |
Returns the settings entry type. More... | |
virtual Q_DECL_DEPRECATED bool | setVariantValue (const QVariant &value, const QString &dynamicKeyPart=QString()) const |
Set settings value. More... | |
virtual Q_DECL_DEPRECATED bool | setVariantValue (const QVariant &value, const QStringList &dynamicKeyPartList) const |
Set settings value. More... | |
Q_DECL_DEPRECATED QVariant | valueAsVariant (const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const |
Returns settings value with an optional default value override. More... | |
QVariant | valueAsVariant (const QString &dynamicKeyPart=QString()) const |
Returns settings value with the dynamicKeyPart argument specifying the dynamic part of the settings key. More... | |
QVariant | valueAsVariant (const QStringList &dynamicKeyPartList) const |
Returns settings value with the dynamicKeyPart argument specifying the dynamic part of the settings key. More... | |
Q_DECL_DEPRECATED QVariant | valueAsVariant (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const |
Returns settings value with an optional default value override. More... | |
QVariant | valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
Returns settings value with a defaultValueOverride. More... | |
QVariant | valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList) const |
Returns settings value. More... | |
Protected Member Functions | |
virtual bool | checkValue (T value) const |
Check if the value is valid. More... | |
virtual T | convertFromVariant (const QVariant &value) const =0 |
Converts the variant value to the value type of the setting. More... | |
virtual QVariant | convertToVariant (T value) const |
Converts the value to a variant. More... | |
virtual bool | setValuePrivate (T value, const QStringList &dynamicKeyPartList) const |
Sets the settings value with an optional list of dynamic parts. More... | |
Protected Member Functions inherited from QgsSettingsEntryBase | |
bool | setVariantValuePrivate (const QVariant &value, const QStringList &dynamicKeyPartList=QStringList()) const |
Sets the settings value with a variant value. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsSettingsEntryBase | |
static QStringList | dynamicKeyPartToList (const QString &dynamicKeyPart) |
Transforms a dynamic key part string to list. More... | |
Base abstract class for settings entry which are passed by value.
Definition at line 494 of file qgssettingsentry.h.
|
inline |
Constructor for QgsSettingsEntryByValue.
The key argument specifies the key of the settings. 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. The options arguments specifies the options for the settings entry.
Definition at line 508 of file qgssettingsentry.h.
|
inlineprotectedvirtual |
Check if the value is valid.
Definition at line 616 of file qgssettingsentry.h.
|
protectedpure virtual |
Converts the variant value to the value type of the setting.
Implemented in QgsSettingsEntryEnumFlag< T >, QgsSettingsEntryEnumFlag< Qgis::DpiMode >, QgsSettingsEntryEnumFlag< Qgis::SnappingMode >, QgsSettingsEntryEnumFlag< Qgis::SnappingType >, QgsSettingsEntryEnumFlag< QgsTolerance::UnitType >, QgsSettingsEntryEnumFlag< Qgis::JoinStyle >, and QgsSettingsEntryEnumFlag< Qgis::EndCapStyle >.
|
inlineprotectedvirtual |
Converts the value to a variant.
Definition at line 610 of file qgssettingsentry.h.
|
inline |
Returns settings default value.
Definition at line 582 of file qgssettingsentry.h.
|
inline |
Returns the former value Returns the current value (or default) if there is no former value.
Definition at line 588 of file qgssettingsentry.h.
|
inline |
Returns the former value Returns the current value (or default) if there is no former value.
Definition at line 594 of file qgssettingsentry.h.
|
overridepure virtual |
Returns the settings entry type.
Implements QgsSettingsEntryBase.
Implemented in QgsSettingsEntryEnumFlag< T >, QgsSettingsEntryEnumFlag< Qgis::DpiMode >, QgsSettingsEntryEnumFlag< Qgis::SnappingMode >, QgsSettingsEntryEnumFlag< Qgis::SnappingType >, QgsSettingsEntryEnumFlag< QgsTolerance::UnitType >, QgsSettingsEntryEnumFlag< Qgis::JoinStyle >, QgsSettingsEntryEnumFlag< Qgis::EndCapStyle >, QgsSettingsEntryBool, QgsSettingsEntryInteger, and QgsSettingsEntryDouble.
|
inline |
Set settings value.
The value to set. The dynamicKeyPart argument specifies the dynamic part of the settings key.
Definition at line 565 of file qgssettingsentry.h.
|
inline |
Set settings value.
The value to set. The dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
Definition at line 576 of file qgssettingsentry.h.
|
inlineprotectedvirtual |
Sets the settings value with an optional list of dynamic parts.
Reimplemented in QgsSettingsEntryEnumFlag< Qgis::DpiMode >, QgsSettingsEntryEnumFlag< Qgis::EndCapStyle >, QgsSettingsEntryEnumFlag< Qgis::JoinStyle >, QgsSettingsEntryEnumFlag< Qgis::SnappingMode >, QgsSettingsEntryEnumFlag< Qgis::SnappingType >, QgsSettingsEntryEnumFlag< QgsTolerance::UnitType >, and QgsSettingsEntryEnumFlag< T >.
Definition at line 598 of file qgssettingsentry.h.
|
inline |
Returns the settings value for the dynamicKeyPart and with a defaultValueOverride.
Definition at line 539 of file qgssettingsentry.h.
|
inline |
Returns settings value.
The dynamicKeyPart argument specifies the dynamic part of the settings key. The defaultValueOverride argument if valid is used instead of the normal default value.
Definition at line 520 of file qgssettingsentry.h.
|
inline |
Returns settings value.
The dynamicKeyPartList argument specifies the list of dynamic parts of the settings key. The defaultValueOverride argument if valid is used instead of the normal default value.
Definition at line 528 of file qgssettingsentry.h.
|
inline |
Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride.
Definition at line 551 of file qgssettingsentry.h.
|
inline |
Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart.
Definition at line 531 of file qgssettingsentry.h.
|
inline |
Returns the settings value with a defaultValueOverride for the dynamicKeyPartList.
Definition at line 533 of file qgssettingsentry.h.