A template class for enum and flag settings entry. More...

#include <qgssettingsentryenumflag.h>

Inheritance diagram for QgsSettingsEntryEnumFlag< T >:

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

T	convertFromVariant (const QVariant &value) const override
	Returns settings default value. More...

virtual Qgis::SettingsType	settingsType () const override
	Returns the settings entry type. More...

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

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

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 &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 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...

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...

Protected Member Functions inherited from QgsSettingsEntryByValue< T >
virtual bool	checkValue (T value) const
	Check if the value is valid. More...

virtual QVariant	convertToVariant (T value) const
	Converts the value to a variant. 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...

Detailed Description

template<typename T>
class QgsSettingsEntryEnumFlag< T >

A template class for enum and flag settings entry.

Note: This template class has a dedicated handling in sipify.pl

Since: QGIS 3.20

Definition at line 34 of file qgssettingsentryenumflag.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryEnumFlag()

template<typename T >

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

inline

Constructor for QgsSettingsEntryEnumFlagBase.

The key argument specifies the final part of the settings key. 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.

Note: The enum needs to be declared with Q_ENUM, and flags with Q_FLAG (not Q_FLAGS).; for Python bindings, a custom implementation is achieved in Python directly

Definition at line 49 of file qgssettingsentryenumflag.h.

Member Function Documentation

◆ convertFromVariant()

template<typename T >

T QgsSettingsEntryEnumFlag< T >::convertFromVariant ( const QVariant & value ) const

inlineoverridevirtual

Returns settings default value.

Implements QgsSettingsEntryByValue< T >.

Definition at line 65 of file qgssettingsentryenumflag.h.

◆ settingsType()

template<typename T >

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

inlineoverridevirtual

Returns the settings entry type.

Implements QgsSettingsEntryByValue< T >.

Definition at line 124 of file qgssettingsentryenumflag.h.

◆ setValuePrivate()

template<typename T >

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

inlineoverridevirtual

Set settings value.

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

Reimplemented from QgsSettingsEntryByValue< T >.

Definition at line 95 of file qgssettingsentryenumflag.h.

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

/build/qgis-3.26.3+32focal/src/core/settings/qgssettingsentryenumflag.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class QgsSettingsEntryEnumFlag< T >

Constructor & Destructor Documentation

◆ QgsSettingsEntryEnumFlag()

Member Function Documentation

◆ convertFromVariant()

◆ settingsType()

◆ setValuePrivate()

template<typename T>
class QgsSettingsEntryEnumFlag< T >