|
| QgsSettingsEntryBaseTemplate (const QString &key, const QString §ion, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) |
| Constructor for QgsSettingsEntryByReference.
|
|
| QgsSettingsEntryBaseTemplate (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) |
| Constructor for QgsSettingsEntryByReference.
|
|
bool | checkValueVariant (const QVariant &value) const override |
| Returns true if the given value is valid towards the setting definition.
|
|
virtual T | convertFromVariant (const QVariant &value) const =0 |
| Converts the variant value to the value type of the setting.
|
|
T | defaultValue () const |
| Returns settings default value.
|
|
T | formerValue (const QString &dynamicKeyPart=QString()) const |
| Returns the former value.
|
|
T | formerValue (const QStringList &dynamicKeyPartList) const |
| Returns the former value Returns the current value (or default) if there is no former value.
|
|
virtual Qgis::SettingsType | settingsType () const override=0 |
| Returns the settings entry type.
|
|
bool | setValue (const T &value, const QString &dynamicKeyPart=QString()) const |
| Set settings value.
|
|
bool | setValue (const T &value, const QStringList &dynamicKeyPartList) const |
| Set settings value.
|
|
T | value (const QString &dynamicKeyPart=QString()) const |
| Returns settings value.
|
|
T | value (const QStringList &dynamicKeyPartList) const |
| Returns settings value.
|
|
T | valueWithDefaultOverride (const T &defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
| Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart.
|
|
T | valueWithDefaultOverride (const T &defaultValueOverride, const QStringList &dynamicKeyPartList) const |
| Returns the settings value with a defaultValueOverride for the dynamicKeyPartList.
|
|
| QgsSettingsEntryBase (const QString &key, const QString §ion, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) |
| Constructor for QgsSettingsEntryBase.
|
|
| QgsSettingsEntryBase (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) |
| Constructor for QgsSettingsEntryBase.
|
|
virtual | ~QgsSettingsEntryBase () |
|
bool | copyValueFromKey (const QString &key, bool removeSettingAtKey=false) const |
| Copies the value from a given key if it exists.
|
|
bool | copyValueFromKey (const QString &key, const QStringList &dynamicKeyPartList, bool removeSettingAtKey=false) const |
| Copies the value from a given key if it exists.
|
|
void | copyValueToKey (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const |
| Copies the settings to the given key.
|
|
void | copyValueToKeyIfChanged (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const |
| Copies the settings to the given key, if it has changed during the current QGIS session (see hasChanged()).
|
|
QVariant | defaultValueAsVariant () const |
| Returns settings default value.
|
|
QString | definitionKey () const |
| Returns settings entry defining key.
|
|
QString | description () const |
| Returns the settings entry description.
|
|
bool | exists (const QString &dynamicKeyPart=QString()) const |
| Returns true if the settings is contained in the underlying QSettings.
|
|
bool | exists (const QStringList &dynamicKeyPartList) const |
| Returns true if the settings is contained in the underlying QSettings.
|
|
QVariant | formerValueAsVariant (const QString &dynamicKeyPart) const |
| Returns the former value of the settings if it has been enabled in the options.
|
|
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.
|
|
bool | hasChanged () const |
| Returns true if the setting was changed during the current QGIS session.
|
|
bool | hasDynamicKey () const |
| Returns true if a part of the settings key is built dynamically.
|
|
QString | key (const QString &dynamicKeyPart=QString()) const |
| Returns settings entry key.
|
|
QString | key (const QStringList &dynamicKeyPartList) const |
| Returns settings entry key.
|
|
bool | keyIsValid (const QString &key) const |
| Returns true if the provided key match the settings entry.
|
|
QString | name () const |
| Returns the name of the settings.
|
|
Qgis::SettingsOptions | options () const |
| Returns the settings options.
|
|
Qgis::SettingsOrigin | origin (const QStringList &dynamicKeyPartList) const |
| Returns the origin of the setting if it exists.
|
|
QgsSettingsTreeNode * | parent () const |
| Returns the parent tree element.
|
|
void | remove (const QString &dynamicKeyPart=QString()) const |
| Removes the settings from the underlying QSettings.
|
|
void | remove (const QStringList &dynamicKeyPartList) const |
| Removes the settings from the underlying QSettings.
|
|
Q_DECL_DEPRECATED int | section () const |
| Returns settings section.
|
|
bool | setVariantValue (const QVariant &value, const QString &dynamicKeyPart=QString()) const |
| Set settings value.
|
|
bool | setVariantValue (const QVariant &value, const QStringList &dynamicKeyPartList) const |
| Set settings value.
|
|
virtual QString | typeId () const |
| Returns the id of the type of settings This can be re-implemented in a custom implementation of a setting.
|
|
Q_DECL_DEPRECATED QVariant | valueAsVariant (const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const |
| Returns settings value with an optional default value override.
|
|
QVariant | valueAsVariant (const QString &dynamicKeyPart=QString()) const |
| Returns settings value with.
|
|
QVariant | valueAsVariant (const QStringList &dynamicKeyPartList) const |
| Returns settings value with.
|
|
Q_DECL_DEPRECATED QVariant | valueAsVariant (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const |
| Returns settings value with an optional default value override.
|
|
QVariant | valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
| Returns settings value with a defaultValueOverride.
|
|
QVariant | valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList) const |
| Returns settings value.
|
|
template<class T>
class QgsSettingsEntryBaseTemplate< T >
Base abstract class for settings entries with typed get and set methods.
- See also
- QgsSettingsEntryBase
- Since
- QGIS 3.32
Definition at line 379 of file qgssettingsentry.h.