QGIS API Documentation 3.41.0-Master (181b2f43d8e)
|
Represent settings entry and provides methods for reading and writing settings values. More...
#include <qgssettingsentry.h>
Public Member Functions | |
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 () |
virtual bool | checkValueVariant (const QVariant &value) const |
Returns true if the given value is valid towards the setting definition. | |
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. | |
virtual Qgis::SettingsType | settingsType () const |
Returns the settings entry type. | |
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. | |
Static Public Member Functions | |
static QStringList | dynamicKeyPartToList (const QString &dynamicKeyPart) |
Transforms a dynamic key part string to list. | |
Represent settings entry and provides methods for reading and writing settings values.
Different subclasses are provided for different settings types with metainformations to validate set values and provide more accurate settings description for the gui.
Definition at line 44 of file qgssettingsentry.h.
|
inline |
Constructor for QgsSettingsEntryBase.
key | specifies the key of the settings. |
section | specifies the section. |
defaultValue | specifies the default value for the settings entry. |
description | specifies a description for the settings entry. |
options | specifies the options for the settings entry. |
Definition at line 89 of file qgssettingsentry.h.
QgsSettingsEntryBase::QgsSettingsEntryBase | ( | const QString & | name, |
QgsSettingsTreeNode * | parent, | ||
const QVariant & | defaultValue = QVariant() , |
||
const QString & | description = QString() , |
||
Qgis::SettingsOptions | options = Qgis::SettingsOptions() |
||
) |
Constructor for QgsSettingsEntryBase.
name | specifies the name of the setting. |
parent | specifies the parent in the tree of settings. |
defaultValue | specifies the default value for the settings entry. |
description | specifies a description for the settings entry. |
options | specifies the options for the settings entry. |
QgsSettingsException | if the number of given parent named items doesn't match the complete key definition |
Definition at line 26 of file qgssettingsentry.cpp.
|
virtual |
Definition at line 41 of file qgssettingsentry.cpp.
|
inlinevirtual |
Returns true
if the given value is valid towards the setting definition.
Reimplemented in QgsSettingsEntryBaseTemplate< T >, QgsSettingsEntryBaseTemplate< bool >, QgsSettingsEntryBaseTemplate< double >, QgsSettingsEntryBaseTemplate< ENUM >, QgsSettingsEntryBaseTemplate< FLAGS >, QgsSettingsEntryBaseTemplate< int >, QgsSettingsEntryBaseTemplate< QColor >, QgsSettingsEntryBaseTemplate< Qgis::DpiMode >, QgsSettingsEntryBaseTemplate< Qgis::EndCapStyle >, QgsSettingsEntryBaseTemplate< Qgis::GpsConnectionType >, QgsSettingsEntryBaseTemplate< Qgis::GpsInformationComponent >, QgsSettingsEntryBaseTemplate< Qgis::JoinStyle >, QgsSettingsEntryBaseTemplate< Qgis::MapToolUnit >, QgsSettingsEntryBaseTemplate< Qgis::SnappingMode >, QgsSettingsEntryBaseTemplate< Qgis::SnappingType >, QgsSettingsEntryBaseTemplate< Qgis::TilePixelRatio >, QgsSettingsEntryBaseTemplate< Qgis::VectorRenderingSimplificationFlags >, QgsSettingsEntryBaseTemplate< Qgis::VectorSimplificationAlgorithm >, QgsSettingsEntryBaseTemplate< qlonglong >, QgsSettingsEntryBaseTemplate< QString >, QgsSettingsEntryBaseTemplate< QStringList >, QgsSettingsEntryBaseTemplate< Qt::TimeSpec >, QgsSettingsEntryBaseTemplate< QVariant >, and QgsSettingsEntryBaseTemplate< QVariantMap >.
Definition at line 342 of file qgssettingsentry.h.
|
inline |
Copies the value from a given key if it exists.
key | the key to copy the setting value from. |
removeSettingAtKey | if true , the setting at the old key will be removed. |
true
if the key exists and the setting value could be copied. Definition at line 305 of file qgssettingsentry.h.
bool QgsSettingsEntryBase::copyValueFromKey | ( | const QString & | key, |
const QStringList & | dynamicKeyPartList, | ||
bool | removeSettingAtKey = false |
||
) | const |
Copies the value from a given key if it exists.
key | the key to copy the setting value from. |
dynamicKeyPartList | is the optional dynamic key part to determine the key. It must be the same for origin and destination keys. |
removeSettingAtKey | if true , the setting at the old key will be removed. |
true
if the key exists and the setting value could be copied. Definition at line 236 of file qgssettingsentry.cpp.
void QgsSettingsEntryBase::copyValueToKey | ( | const QString & | key, |
const QStringList & | dynamicKeyPartList = QStringList() |
||
) | const |
Copies the settings to the given key.
key | the key to copy the setting value to. |
dynamicKeyPartList | is the optional dynamic key part to determine the key. It must be the same for origin and destination keys. |
Definition at line 259 of file qgssettingsentry.cpp.
void QgsSettingsEntryBase::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()).
key | the key to copy the setting value to. |
dynamicKeyPartList | is the optional dynamic key part to determine the key. It must be the same for origin and destination keys. |
Definition at line 265 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::defaultValueAsVariant | ( | ) | const |
Returns settings default value.
Definition at line 214 of file qgssettingsentry.cpp.
QString QgsSettingsEntryBase::definitionKey | ( | ) | const |
Returns settings entry defining key.
For dynamic settings it return the key with the placeholder for dynamic part included. For non-dynamic settings returns the same as key().
Definition at line 106 of file qgssettingsentry.cpp.
QString QgsSettingsEntryBase::description | ( | ) | const |
Returns the settings entry description.
Definition at line 219 of file qgssettingsentry.cpp.
|
static |
Transforms a dynamic key part string to list.
Definition at line 171 of file qgssettingsentry.cpp.
bool QgsSettingsEntryBase::exists | ( | const QString & | dynamicKeyPart = QString() | ) | const |
Returns true
if the settings is contained in the underlying QSettings.
dynamicKeyPart | specifies the dynamic part of the settings key. |
Definition at line 117 of file qgssettingsentry.cpp.
bool QgsSettingsEntryBase::exists | ( | const QStringList & | dynamicKeyPartList | ) | const |
Returns true
if the settings is contained in the underlying QSettings.
dynamicKeyPartList | specifies the list of dynamic parts of the settings key. |
Definition at line 122 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::formerValueAsVariant | ( | const QString & | dynamicKeyPart | ) | 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.
Definition at line 224 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::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.
Definition at line 229 of file qgssettingsentry.cpp.
|
inline |
Returns true
if the setting was changed during the current QGIS session.
Definition at line 353 of file qgssettingsentry.h.
bool QgsSettingsEntryBase::hasDynamicKey | ( | ) | const |
Returns true
if a part of the settings key is built dynamically.
Definition at line 111 of file qgssettingsentry.cpp.
QString QgsSettingsEntryBase::key | ( | const QString & | dynamicKeyPart = QString() | ) | const |
Returns settings entry key.
dynamicKeyPart | specifies the dynamic part of the settings key. |
Definition at line 53 of file qgssettingsentry.cpp.
QString QgsSettingsEntryBase::key | ( | const QStringList & | dynamicKeyPartList | ) | const |
Returns settings entry key.
dynamicKeyPartList | specifies the list of dynamic parts of the settings key. |
Definition at line 58 of file qgssettingsentry.cpp.
bool QgsSettingsEntryBase::keyIsValid | ( | const QString & | key | ) | const |
Returns true
if the provided key match the settings entry.
This is useful for settings with dynamic keys. For example this permits one to check that the settings key "NewsFeed/httpsfeedqgisorg/27/content" is valid for the settings entry defined with the key "NewsFeed/%1/%2/content"
key | to check |
Definition at line 90 of file qgssettingsentry.cpp.
|
inline |
|
inline |
Qgis::SettingsOrigin QgsSettingsEntryBase::origin | ( | const QStringList & | dynamicKeyPartList | ) | const |
Returns the origin of the setting if it exists.
Definition at line 127 of file qgssettingsentry.cpp.
|
inline |
void QgsSettingsEntryBase::remove | ( | const QString & | dynamicKeyPart = QString() | ) | const |
Removes the settings from the underlying QSettings.
dynamicKeyPart | specifies the dynamic part of the settings key. |
Definition at line 132 of file qgssettingsentry.cpp.
void QgsSettingsEntryBase::remove | ( | const QStringList & | dynamicKeyPartList | ) | const |
Removes the settings from the underlying QSettings.
dynamicKeyPartList | specifies the list of dynamic parts of the settings key. |
Definition at line 137 of file qgssettingsentry.cpp.
int QgsSettingsEntryBase::section | ( | ) | const |
Returns settings section.
The settings section of the parent group is returned if available.
Definition at line 142 of file qgssettingsentry.cpp.
|
inlinevirtual |
Returns the settings entry type.
Reimplemented in QgsSettingsEntryEnumFlag< T >, QgsSettingsEntryEnumFlag< ENUM >, QgsSettingsEntryEnumFlag< FLAGS >, QgsSettingsEntryEnumFlag< Qgis::DpiMode >, QgsSettingsEntryEnumFlag< Qgis::EndCapStyle >, QgsSettingsEntryEnumFlag< Qgis::GpsConnectionType >, QgsSettingsEntryEnumFlag< Qgis::GpsInformationComponent >, QgsSettingsEntryEnumFlag< Qgis::JoinStyle >, QgsSettingsEntryEnumFlag< Qgis::MapToolUnit >, QgsSettingsEntryEnumFlag< Qgis::SnappingMode >, QgsSettingsEntryEnumFlag< Qgis::SnappingType >, QgsSettingsEntryEnumFlag< Qgis::TilePixelRatio >, QgsSettingsEntryEnumFlag< Qgis::VectorRenderingSimplificationFlags >, QgsSettingsEntryEnumFlag< Qgis::VectorSimplificationAlgorithm >, QgsSettingsEntryEnumFlag< Qt::TimeSpec >, QgsSettingsEntryVariant, QgsSettingsEntryString, QgsSettingsEntryStringList, QgsSettingsEntryBool, QgsSettingsEntryInteger, QgsSettingsEntryInteger64, QgsSettingsEntryDouble, QgsSettingsEntryColor, QgsSettingsEntryVariantMap, QgsSettingsEntryBaseTemplate< T >, QgsSettingsEntryBaseTemplate< bool >, QgsSettingsEntryBaseTemplate< double >, QgsSettingsEntryBaseTemplate< ENUM >, QgsSettingsEntryBaseTemplate< FLAGS >, QgsSettingsEntryBaseTemplate< int >, QgsSettingsEntryBaseTemplate< QColor >, QgsSettingsEntryBaseTemplate< Qgis::DpiMode >, QgsSettingsEntryBaseTemplate< Qgis::EndCapStyle >, QgsSettingsEntryBaseTemplate< Qgis::GpsConnectionType >, QgsSettingsEntryBaseTemplate< Qgis::GpsInformationComponent >, QgsSettingsEntryBaseTemplate< Qgis::JoinStyle >, QgsSettingsEntryBaseTemplate< Qgis::MapToolUnit >, QgsSettingsEntryBaseTemplate< Qgis::SnappingMode >, QgsSettingsEntryBaseTemplate< Qgis::SnappingType >, QgsSettingsEntryBaseTemplate< Qgis::TilePixelRatio >, QgsSettingsEntryBaseTemplate< Qgis::VectorRenderingSimplificationFlags >, QgsSettingsEntryBaseTemplate< Qgis::VectorSimplificationAlgorithm >, QgsSettingsEntryBaseTemplate< qlonglong >, QgsSettingsEntryBaseTemplate< QString >, QgsSettingsEntryBaseTemplate< QStringList >, QgsSettingsEntryBaseTemplate< Qt::TimeSpec >, QgsSettingsEntryBaseTemplate< QVariant >, and QgsSettingsEntryBaseTemplate< QVariantMap >.
Definition at line 276 of file qgssettingsentry.h.
bool QgsSettingsEntryBase::setVariantValue | ( | const QVariant & | value, |
const QString & | dynamicKeyPart = QString() |
||
) | const |
Set settings value.
value | specifies the value to set. |
dynamicKeyPart | specifies the dynamic part of the settings key. |
Definition at line 147 of file qgssettingsentry.cpp.
bool QgsSettingsEntryBase::setVariantValue | ( | const QVariant & | value, |
const QStringList & | dynamicKeyPartList | ||
) | const |
Set settings value.
This should be called from any implementation as it takes care of actually calling QSettings
value | specifies the value to set. |
dynamicKeyPartList | specifies the list of dynamic parts of the settings key. |
Definition at line 152 of file qgssettingsentry.cpp.
|
virtual |
Returns the id of the type of settings This can be re-implemented in a custom implementation of a setting.
Reimplemented in QgsSettingsEntryEnumFlag< T >, QgsSettingsEntryEnumFlag< ENUM >, QgsSettingsEntryEnumFlag< FLAGS >, QgsSettingsEntryEnumFlag< Qgis::DpiMode >, QgsSettingsEntryEnumFlag< Qgis::EndCapStyle >, QgsSettingsEntryEnumFlag< Qgis::GpsConnectionType >, QgsSettingsEntryEnumFlag< Qgis::GpsInformationComponent >, QgsSettingsEntryEnumFlag< Qgis::JoinStyle >, QgsSettingsEntryEnumFlag< Qgis::MapToolUnit >, QgsSettingsEntryEnumFlag< Qgis::SnappingMode >, QgsSettingsEntryEnumFlag< Qgis::SnappingType >, QgsSettingsEntryEnumFlag< Qgis::TilePixelRatio >, QgsSettingsEntryEnumFlag< Qgis::VectorRenderingSimplificationFlags >, QgsSettingsEntryEnumFlag< Qgis::VectorSimplificationAlgorithm >, and QgsSettingsEntryEnumFlag< Qt::TimeSpec >.
Definition at line 47 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::valueAsVariant | ( | const QString & | dynamicKeyPart, |
bool | useDefaultValueOverride, | ||
const QVariant & | defaultValueOverride | ||
) | const |
Returns settings value with an optional default value override.
Definition at line 189 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::valueAsVariant | ( | const QString & | dynamicKeyPart = QString() | ) | const |
Returns settings value with.
dynamicKeyPart | specifying the dynamic part of the settings key. |
Definition at line 179 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::valueAsVariant | ( | const QStringList & | dynamicKeyPartList | ) | const |
Returns settings value with.
dynamicKeyPartList | specifying the dynamic part of the settings key. |
Definition at line 184 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::valueAsVariant | ( | const QStringList & | dynamicKeyPartList, |
bool | useDefaultValueOverride, | ||
const QVariant & | defaultValueOverride | ||
) | const |
Returns settings value with an optional default value override.
Definition at line 196 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::valueAsVariantWithDefaultOverride | ( | const QVariant & | defaultValueOverride, |
const QString & | dynamicKeyPart = QString() |
||
) | const |
Returns settings value with a defaultValueOverride.
Definition at line 204 of file qgssettingsentry.cpp.
QVariant QgsSettingsEntryBase::valueAsVariantWithDefaultOverride | ( | const QVariant & | defaultValueOverride, |
const QStringList & | dynamicKeyPartList | ||
) | const |
Returns settings value.
dynamicKeyPartList | specifies the list of dynamic parts of the settings key. |
defaultValueOverride | if valid is used instead of the normal default value. |
Definition at line 209 of file qgssettingsentry.cpp.