Base abstract class for settings entry which are passed by reference. More...

#include <qgssettingsentry.h>

Inheritance diagram for QgsSettingsEntryByReference< T >:

Public Member Functions
	QgsSettingsEntryByReference (const QString &key, const QString &section, const T &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
	Constructor for QgsSettingsEntryByReference. More...

T	defaultValue () const
	Returns settings default value. More...

T	formerValue (const QString &dynamicKeyPart=QString()) const
	Returns the 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 (const T &value, const QString &dynamicKeyPart=QString()) const
	Set settings value. More...

bool	setValue (const T &value, const QStringList &dynamicKeyPartList) const
	Set settings value. More...

Q_DECL_DEPRECATED T	value (const QString &dynamicKeyPart, bool useDefaultValueOverride, const 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, const T &defaultValueOverride) const
	Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride. More...

T	valueWithDefaultOverride (const T &defaultValueOverride, const QString &dynamicKeyPart=QString()) const
	Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. More...

T	valueWithDefaultOverride (const 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 &section, 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 (const 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 (const T &value) const
	Converts the value to a variant. More...

bool	setValuePrivate (const 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...

Detailed Description

template<class T>
class QgsSettingsEntryByReference< T >

Base abstract class for settings entry which are passed by reference.

See also: QgsSettingsEntryBase; QgsSettingsEntryByValue

Since: QGIS 3.26

Definition at line 350 of file qgssettingsentry.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryByReference()

template<class T >

QgsSettingsEntryByReference< T >::QgsSettingsEntryByReference	(	const QString &	key,
		const QString &	section,
		const T &	defaultValue,
		const QString &	description = `QString()`,
		Qgis::SettingsOptions	options = `Qgis::SettingsOptions()`
	)

inline

Constructor for QgsSettingsEntryByReference.

The key argument specifies the key of the settings. 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 362 of file qgssettingsentry.h.

Member Function Documentation

◆ checkValue()

template<class T >

virtual bool QgsSettingsEntryByReference< T >::checkValue ( const T & value ) const

inlineprotectedvirtual

Check if the value is valid.

Definition at line 475 of file qgssettingsentry.h.

◆ convertFromVariant()

template<class T >

virtual T QgsSettingsEntryByReference< T >::convertFromVariant ( const QVariant & value ) const

protectedpure virtual

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

◆ convertToVariant()

template<class T >

virtual QVariant QgsSettingsEntryByReference< T >::convertToVariant ( const T & value ) const

inlineprotectedvirtual

Converts the value to a variant.

Definition at line 469 of file qgssettingsentry.h.

◆ defaultValue()

template<class T >

T QgsSettingsEntryByReference< T >::defaultValue ( ) const

inline

Returns settings default value.

Definition at line 441 of file qgssettingsentry.h.

◆ formerValue() [1/2]

template<class T >

T QgsSettingsEntryByReference< 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 447 of file qgssettingsentry.h.

◆ formerValue() [2/2]

template<class T >

T QgsSettingsEntryByReference< 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 453 of file qgssettingsentry.h.

◆ settingsType()

template<class T >

virtual Qgis::SettingsType QgsSettingsEntryByReference< T >::settingsType ( ) const

overridepure virtual

Returns the settings entry type.

Implements QgsSettingsEntryBase.

Implemented in QgsSettingsEntryVariant, QgsSettingsEntryString, QgsSettingsEntryStringList, and QgsSettingsEntryColor.

◆ setValue() [1/2]

template<class T >

bool QgsSettingsEntryByReference< T >::setValue	(	const T &	value,
		const QString &	dynamicKeyPart = `QString()`
	)		const

inline

Set settings value.

The value to set. The dynamicKeyPart argument specifies the dynamic part of the settings key.

Definition at line 424 of file qgssettingsentry.h.

◆ setValue() [2/2]

template<class T >

bool QgsSettingsEntryByReference< T >::setValue	(	const T &	value,
		const QStringList &	dynamicKeyPartList
	)		const

inline

Set settings value.

The value to set. The dynamicKeyParts argument specifies the list of dynamic parts of the settings key.

Definition at line 435 of file qgssettingsentry.h.

◆ setValuePrivate()

template<class T >

bool QgsSettingsEntryByReference< T >::setValuePrivate	(	const T &	value,
		const QStringList &	dynamicKeyPartList
	)		const

inlineprotected

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

Definition at line 457 of file qgssettingsentry.h.

◆ value() [1/4]

template<class T >

Q_DECL_DEPRECATED T QgsSettingsEntryByReference< T >::value	(	const QString &	dynamicKeyPart,
		bool	useDefaultValueOverride,
		const T &	defaultValueOverride
	)		const

inline

Returns the settings value for the dynamicKeyPart and with a defaultValueOverride.

Deprecated:: since QGIS 3.26 use valueAsVariantWithDefaultOverride instead

Definition at line 398 of file qgssettingsentry.h.

◆ value() [2/4]

template<class T >

T QgsSettingsEntryByReference< T >::value ( const QString & dynamicKeyPart = QString() ) const

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

◆ value() [3/4]

template<class T >

T QgsSettingsEntryByReference< T >::value ( const QStringList & dynamicKeyPartList ) const

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

◆ value() [4/4]

template<class T >

Q_DECL_DEPRECATED T QgsSettingsEntryByReference< T >::value	(	const QStringList &	dynamicKeyPartList,
		bool	useDefaultValueOverride,
		const T &	defaultValueOverride
	)		const

inline

Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride.

Deprecated:: since QGIS 3.26 use valueAsVariantWithDefaultOverride instead

Definition at line 410 of file qgssettingsentry.h.

◆ valueWithDefaultOverride() [1/2]

template<class T >

T QgsSettingsEntryByReference< 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 390 of file qgssettingsentry.h.

◆ valueWithDefaultOverride() [2/2]

template<class T >

T QgsSettingsEntryByReference< T >::valueWithDefaultOverride	(	const T &	defaultValueOverride,
		const QStringList &	dynamicKeyPartList
	)		const

inline

Returns the settings value with a defaultValueOverride for the dynamicKeyPartList.

Definition at line 392 of file qgssettingsentry.h.

The documentation for this class was generated from the following file:

/build/qgis-3.28.0+99sid/src/core/settings/qgssettingsentry.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSettingsEntryByReference()

Member Function Documentation

◆ checkValue()

◆ convertFromVariant()

◆ convertToVariant()

◆ defaultValue()

◆ formerValue() [1/2]

◆ formerValue() [2/2]

◆ settingsType()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ setValuePrivate()

◆ value() [1/4]

◆ value() [2/4]

◆ value() [3/4]

◆ value() [4/4]

◆ valueWithDefaultOverride() [1/2]

◆ valueWithDefaultOverride() [2/2]