QGIS API Documentation 3.99.0-Master (f78f5286a64)
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
QgsSettingsEntryBaseTemplate< T > Class Template Referenceabstract
core library

Base abstract class for settings entries with typed get and set methods. More...

#include <qgssettingsentry.h>

Inheritance diagram for QgsSettingsEntryBaseTemplate< T >:
Inheritance graph
[legend]

Public Member Functions

 QgsSettingsEntryBaseTemplate (const QString &key, const QString &section, 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.
 
- Public Member Functions inherited from QgsSettingsEntryBase
 QgsSettingsEntryBase (const QString &key, const QString &section, 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.
 

Protected Member Functions

virtual bool checkValuePrivate (const T &value) const
 Check if the value is valid.
 
virtual QVariant convertToVariant (const T &value) const
 Converts the value to a variant.
 
virtual bool setValuePrivate (const T &value, const QStringList &dynamicKeyPartList) const
 Sets the settings value with an optional list of dynamic parts.
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsSettingsEntryBase
static QStringList dynamicKeyPartToList (const QString &dynamicKeyPart)
 Transforms a dynamic key part string to list.
 

Detailed Description

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 380 of file qgssettingsentry.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryBaseTemplate() [1/2]

template<class T >
QgsSettingsEntryBaseTemplate< T >::QgsSettingsEntryBaseTemplate ( const QString &  name,
QgsSettingsTreeNode *  parent,
const QVariant &  defaultValue,
const QString &  description = QString(),
Qgis::SettingsOptions  options = Qgis::SettingsOptions() 
)
inline

Constructor for QgsSettingsEntryByReference.

Parameters
namespecifies the key of the settings.
parentspecifies the parent in the tree of settings.
defaultValuespecifies the default value for the settings entry.
descriptionspecifies a description for the settings entry.
optionsspecifies the options for the settings entry.
Exceptions
QgsSettingsExceptionif the number of given parent named items doesn't match the complete key definition
Since
QGIS 3.30

Definition at line 396 of file qgssettingsentry.h.

◆ QgsSettingsEntryBaseTemplate() [2/2]

template<class T >
QgsSettingsEntryBaseTemplate< T >::QgsSettingsEntryBaseTemplate ( const QString &  key,
const QString &  section,
const QVariant &  defaultValue,
const QString &  description = QString(),
Qgis::SettingsOptions  options = Qgis::SettingsOptions() 
)
inline

Constructor for QgsSettingsEntryByReference.

Parameters
keyspecifies the key of the settings.
sectionspecifies the section.
defaultValuespecifies the default value for the settings entry.
descriptionspecifies a description for the settings entry.
optionsspecifies the options for the settings entry.

Definition at line 413 of file qgssettingsentry.h.

Member Function Documentation

◆ checkValuePrivate()

template<class T >
virtual bool QgsSettingsEntryBaseTemplate< T >::checkValuePrivate ( const T &  value) const
inlineprotectedvirtual

Check if the value is valid.

Definition at line 513 of file qgssettingsentry.h.

◆ checkValueVariant()

template<class T >
bool QgsSettingsEntryBaseTemplate< T >::checkValueVariant ( const QVariant &  value) const
inlineoverridevirtual

Returns true if the given value is valid towards the setting definition.

Reimplemented from QgsSettingsEntryBase.

Definition at line 488 of file qgssettingsentry.h.

◆ convertFromVariant()

template<class T >
virtual T QgsSettingsEntryBaseTemplate< T >::convertFromVariant ( const QVariant &  value) const
pure virtual

Converts the variant value to the value type of the setting.

Implemented in QgsSettingsEntryEnumFlag< T >, QgsSettingsEntryEnumFlag< ENUM >, QgsSettingsEntryEnumFlag< FLAGS >, QgsSettingsEntryEnumFlag< Qgis::DpiMode >, QgsSettingsEntryEnumFlag< Qgis::EndCapStyle >, QgsSettingsEntryEnumFlag< Qgis::GpsConnectionType >, QgsSettingsEntryEnumFlag< Qgis::GpsInformationComponent >, QgsSettingsEntryEnumFlag< Qgis::HttpMethod >, 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, and QgsSettingsEntryVariantMap.

◆ convertToVariant()

template<class T >
virtual QVariant QgsSettingsEntryBaseTemplate< T >::convertToVariant ( const T &  value) const
inlineprotectedvirtual

Converts the value to a variant.

Reimplemented in QgsSettingsEntryEnumFlag< T >.

Definition at line 507 of file qgssettingsentry.h.

◆ defaultValue()

template<class T >
T QgsSettingsEntryBaseTemplate< T >::defaultValue ( ) const
inline

Returns settings default value.

Definition at line 474 of file qgssettingsentry.h.

◆ formerValue() [1/2]

template<class T >
T QgsSettingsEntryBaseTemplate< T >::formerValue ( const QString &  dynamicKeyPart = QString()) const
inline

Returns the former value.

Returns the current value (or default) if there is no former value.

Definition at line 480 of file qgssettingsentry.h.

◆ formerValue() [2/2]

template<class T >
T QgsSettingsEntryBaseTemplate< T >::formerValue ( const QStringList &  dynamicKeyPartList) const
inline

Returns the former value Returns the current value (or default) if there is no former value.

Definition at line 486 of file qgssettingsentry.h.

◆ settingsType()

template<class T >
virtual Qgis::SettingsType QgsSettingsEntryBaseTemplate< T >::settingsType ( ) const
overridepure virtual

Returns the settings entry type.

Reimplemented from QgsSettingsEntryBase.

Implemented in QgsSettingsEntryEnumFlag< T >, QgsSettingsEntryEnumFlag< ENUM >, QgsSettingsEntryEnumFlag< FLAGS >, QgsSettingsEntryEnumFlag< Qgis::DpiMode >, QgsSettingsEntryEnumFlag< Qgis::EndCapStyle >, QgsSettingsEntryEnumFlag< Qgis::GpsConnectionType >, QgsSettingsEntryEnumFlag< Qgis::GpsInformationComponent >, QgsSettingsEntryEnumFlag< Qgis::HttpMethod >, 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, and QgsSettingsEntryVariantMap.

◆ setValue() [1/2]

template<class T >
bool QgsSettingsEntryBaseTemplate< T >::setValue ( const T &  value,
const QString &  dynamicKeyPart = QString() 
) const
inline

Set settings value.

Parameters
valuespecifies the value to set.
dynamicKeyPartspecifies the dynamic part of the settings key.

Definition at line 457 of file qgssettingsentry.h.

◆ setValue() [2/2]

template<class T >
bool QgsSettingsEntryBaseTemplate< T >::setValue ( const T &  value,
const QStringList &  dynamicKeyPartList 
) const
inline

Set settings value.

Parameters
valuespecifies the value to set.
dynamicKeyPartListspecifies the list of dynamic parts of the settings key.

Definition at line 468 of file qgssettingsentry.h.

◆ setValuePrivate()

template<class T >
virtual bool QgsSettingsEntryBaseTemplate< T >::setValuePrivate ( const T &  value,
const QStringList &  dynamicKeyPartList 
) const
inlineprotectedvirtual

Sets the settings value with an optional list of dynamic parts.

Reimplemented in QgsSettingsEntryEnumFlag< T >.

Definition at line 498 of file qgssettingsentry.h.

◆ value() [1/2]

template<class T >
T QgsSettingsEntryBaseTemplate< T >::value ( const QString &  dynamicKeyPart = QString()) const
inline

Returns settings value.

Parameters
dynamicKeyPartspecifies the dynamic part of the settings key.

Definition at line 429 of file qgssettingsentry.h.

◆ value() [2/2]

template<class T >
T QgsSettingsEntryBaseTemplate< T >::value ( const QStringList &  dynamicKeyPartList) const
inline

Returns settings value.

Parameters
dynamicKeyPartListspecifies the list of dynamic parts of the settings key.

Definition at line 436 of file qgssettingsentry.h.

◆ valueWithDefaultOverride() [1/2]

template<class T >
T QgsSettingsEntryBaseTemplate< T >::valueWithDefaultOverride ( const T &  defaultValueOverride,
const QString &  dynamicKeyPart = QString() 
) const
inline

Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart.

Definition at line 440 of file qgssettingsentry.h.

◆ valueWithDefaultOverride() [2/2]

template<class T >
T QgsSettingsEntryBaseTemplate< T >::valueWithDefaultOverride ( const T &  defaultValueOverride,
const QStringList &  dynamicKeyPartList 
) const
inline

Returns the settings value with a defaultValueOverride for the dynamicKeyPartList.

Definition at line 446 of file qgssettingsentry.h.

The documentation for this class was generated from the following file:
Generated on Fri Jul 18 2025 14:01:06 for QGIS API Documentation by doxygen 1.9.8