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

#include <qgssettingsentryenumflag.h>

Inheritance diagram for QgsSettingsEntryEnumFlag< T >:

[legend]

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

	QgsSettingsEntryEnumFlag (const QString &name, QgsSettingsTreeNode *parent, T defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
	Constructor for QgsSettingsEntryEnumFlagBase.

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

QVariant	convertToVariant (const T &value) const override
	Converts the value to a variant.

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

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

virtual QString	typeId () const override
	Returns the id of the type of settings This can be re-implemented in a custom implementation of a setting.

Public Member Functions inherited from QgsSettingsEntryBaseTemplate< T >
	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.

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.

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.

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.

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

Protected Member Functions inherited from QgsSettingsEntryBaseTemplate< T >
virtual bool	checkValuePrivate (const T &value) const
	Check if the value is valid.

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

Since: QGIS 3.20

Definition at line 35 of file qgssettingsentryenumflag.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryEnumFlag() [1/2]

template<typename T >

QgsSettingsEntryEnumFlag< T >::QgsSettingsEntryEnumFlag	(	const QString &	name,
		QgsSettingsTreeNode *	parent,
		T	defaultValue,
		const QString &	description = `QString()`,
		Qgis::SettingsOptions	options = `Qgis::SettingsOptions()`
	)

inline

Constructor for QgsSettingsEntryEnumFlagBase.

Parameters

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.

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

Since: QGIS 3.30

Definition at line 52 of file qgssettingsentryenumflag.h.

◆ QgsSettingsEntryEnumFlag() [2/2]

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.

Parameters

key	specifies the final part of the setting key.
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.

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 77 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 QgsSettingsEntryBaseTemplate< T >.

Definition at line 102 of file qgssettingsentryenumflag.h.

◆ convertToVariant()

template<typename T >

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

inlineoverridevirtual

Converts the value to a variant.

Reimplemented from QgsSettingsEntryBaseTemplate< T >.

Definition at line 90 of file qgssettingsentryenumflag.h.

◆ settingsType()

template<typename T >

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

inlineoverridevirtual

Returns the settings entry type.

Implements QgsSettingsEntryBaseTemplate< T >.

Definition at line 161 of file qgssettingsentryenumflag.h.

◆ setValuePrivate()

template<typename T >

bool QgsSettingsEntryEnumFlag< T >::setValuePrivate	(	const 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 QgsSettingsEntryBaseTemplate< T >.

Definition at line 132 of file qgssettingsentryenumflag.h.

◆ typeId()

template<typename T >

virtual QString QgsSettingsEntryEnumFlag< T >::typeId ( ) const

inlineoverridevirtual

Returns the id of the type of settings This can be re-implemented in a custom implementation of a setting.

Since: QGIS 3.32

Reimplemented from QgsSettingsEntryBase.

Definition at line 166 of file qgssettingsentryenumflag.h.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/qgsowsconnection.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/settings/qgssettingsentryenumflag.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSettingsEntryEnumFlag() [1/2]

◆ QgsSettingsEntryEnumFlag() [2/2]

Member Function Documentation

◆ convertFromVariant()

◆ convertToVariant()

◆ settingsType()

◆ setValuePrivate()

◆ typeId()