A boolean settings entry. More...

#include <qgssettingsentry.h>

Inheritance diagram for QgsSettingsEntryBool:

Public Member Functions
	QgsSettingsEntryBool (const QString &key, const QString &pluginName, bool defaultValue=false, const QString &description=QString())
	Constructor for QgsSettingsEntryBool. More...

	QgsSettingsEntryBool (const QString &key, QgsSettings::Section section, bool defaultValue=false, const QString &description=QString())
	Constructor for QgsSettingsEntryBool. More...

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

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

bool	setValue (bool value, const QString &dynamicKeyPart=QString()) const
	Set settings value. More...

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

bool	value (const QString &dynamicKeyPart=QString(), bool useDefaultValueOverride=false, bool defaultValueOverride=false) const
	Returns settings value. More...

bool	value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride=false, bool defaultValueOverride=false) const
	Returns settings value. More...

Public Member Functions inherited from QgsSettingsEntryBase
	QgsSettingsEntryBase (const QString &key, const QString &pluginName, const QVariant &defaultValue=QVariant(), const QString &description=QString())
	Constructor for QgsSettingsEntryBase. More...

	QgsSettingsEntryBase (const QString &key, QgsSettings::Section section, const QVariant &defaultValue=QVariant(), const QString &description=QString())
	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...

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

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

QgsSettings::Section	section () const
	Returns settings section. More...

virtual bool	setVariantValue (const QVariant &value, const QString &dynamicKeyPart=QString()) const
	Set settings value. More...

virtual bool	setVariantValue (const QVariant &value, const QStringList &dynamicKeyPartList) const
	Set settings value. More...

QVariant	valueAsVariant (const QString &dynamicKeyPart=QString(), bool useDefaultValueOverride=false, const QVariant &defaultValueOverride=QVariant()) const
	Returns settings value. More...

QVariant	valueAsVariant (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride=false, const QVariant &defaultValueOverride=QVariant()) const
	Returns settings value. More...

Additional Inherited Members
Public Types inherited from QgsSettingsEntryBase
enum class	SettingsType : int { Variant , String , StringList , Bool , Integer , Double , EnumFlag , Color }
	Types of settings entries. More...

Detailed Description

A boolean settings entry.

Since: QGIS 3.20

Definition at line 539 of file qgssettingsentry.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryBool() [1/2]

QgsSettingsEntryBool::QgsSettingsEntryBool	(	const QString &	key,
		QgsSettings::Section	section,
		bool	defaultValue = `false`,
		const QString &	description = `QString()`
	)

Constructor for QgsSettingsEntryBool.

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.

Definition at line 409 of file qgssettingsentry.cpp.

◆ QgsSettingsEntryBool() [2/2]

QgsSettingsEntryBool::QgsSettingsEntryBool	(	const QString &	key,
		const QString &	pluginName,
		bool	defaultValue = `false`,
		const QString &	description = `QString()`
	)

Constructor for QgsSettingsEntryBool.

This constructor is intended to be used from plugins.

The key argument specifies the key of the settings. The pluginName argument is inserted in the key after the section. The defaultValue argument specifies the default value for the settings entry. The description argument specifies a description for the settings entry.

Definition at line 417 of file qgssettingsentry.cpp.

Member Function Documentation

◆ defaultValue()

bool QgsSettingsEntryBool::defaultValue ( ) const

Returns settings default value.

Definition at line 445 of file qgssettingsentry.cpp.

◆ settingsType()

QgsSettingsEntryBase::SettingsType QgsSettingsEntryBool::settingsType ( ) const

overridevirtual

Returns the settings entry type.

Implements QgsSettingsEntryBase.

Definition at line 450 of file qgssettingsentry.cpp.

◆ setValue() [1/2]

bool QgsSettingsEntryBool::setValue	(	bool	value,
		const QString &	dynamicKeyPart = `QString()`
	)		const

Set settings value.

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

Definition at line 425 of file qgssettingsentry.cpp.

◆ setValue() [2/2]

bool QgsSettingsEntryBool::setValue	(	bool	value,
		const QStringList &	dynamicKeyPartList
	)		const

Set settings value.

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

Definition at line 430 of file qgssettingsentry.cpp.

◆ value() [1/2]

bool QgsSettingsEntryBool::value	(	const QString &	dynamicKeyPart = `QString()`,
		bool	useDefaultValueOverride = `false`,
		bool	defaultValueOverride = `false`
	)		const

Returns settings value.

The dynamicKeyPart argument specifies the dynamic part of the settings key. The useDefaultValueOverride argument specifies if defaultValueOverride should be used. The defaultValueOverride argument if valid is used instead of the normal default value.

Definition at line 435 of file qgssettingsentry.cpp.

◆ value() [2/2]

bool QgsSettingsEntryBool::value	(	const QStringList &	dynamicKeyPartList,
		bool	useDefaultValueOverride = `false`,
		bool	defaultValueOverride = `false`
	)		const