An integer settings entry. More...

#include <qgssettingsentry.h>

Inheritance diagram for QgsSettingsEntryInteger:

Public Member Functions
	QgsSettingsEntryInteger (const QString &key, const QString &pluginName, qlonglong defaultValue=0, const QString &description=QString())
	Constructor for QgsSettingsEntryInteger. More...

	QgsSettingsEntryInteger (const QString &key, QgsSettings::Section section, qlonglong defaultValue=0, const QString &description=QString(), qlonglong minValue=std::numeric_limits< qlonglong >::min(), qlonglong maxValue=std::numeric_limits< qlonglong >::max())
	Constructor for QgsSettingsEntryInteger. More...

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

qlonglong	maxValue ()
	Returns the maximum value. More...

qlonglong	minValue ()
	Returns the minimum value. More...

void	setMaxValue (qlonglong maxValue)
	Set the maximum value. More...

void	setMinValue (qlonglong minValue)
	Set the minimum value. More...

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

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

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

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

qlonglong	value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride=false, qlonglong defaultValueOverride=0) 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

An integer settings entry.

Since: QGIS 3.20

Definition at line 624 of file qgssettingsentry.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryInteger() [1/2]

QgsSettingsEntryInteger::QgsSettingsEntryInteger	(	const QString &	key,
		QgsSettings::Section	section,
		qlonglong	defaultValue = `0`,
		const QString &	description = `QString()`,
		qlonglong	minValue = `std::numeric_limits<qlonglong>::min()`,
		qlonglong	maxValue = `std::numeric_limits<qlonglong>::max()`
	)

Constructor for QgsSettingsEntryInteger.

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. The minValue argument specifies the minimal value. The maxValue argument specifies the maximal value.

Definition at line 455 of file qgssettingsentry.cpp.

◆ QgsSettingsEntryInteger() [2/2]

QgsSettingsEntryInteger::QgsSettingsEntryInteger	(	const QString &	key,
		const QString &	pluginName,
		qlonglong	defaultValue = `0`,
		const QString &	description = `QString()`
	)

Constructor for QgsSettingsEntryInteger.

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 465 of file qgssettingsentry.cpp.

Member Function Documentation

◆ defaultValue()

qlonglong QgsSettingsEntryInteger::defaultValue ( ) const

Returns settings default value.

Definition at line 517 of file qgssettingsentry.cpp.

◆ maxValue()

qlonglong QgsSettingsEntryInteger::maxValue ( )

Returns the maximum value.

Definition at line 542 of file qgssettingsentry.cpp.

◆ minValue()

qlonglong QgsSettingsEntryInteger::minValue ( )

Returns the minimum value.

Definition at line 532 of file qgssettingsentry.cpp.

◆ setMaxValue()

void QgsSettingsEntryInteger::setMaxValue ( qlonglong maxValue )

Set the maximum value.

maxValue The maximum value.

Definition at line 537 of file qgssettingsentry.cpp.

◆ setMinValue()

void QgsSettingsEntryInteger::setMinValue ( qlonglong minValue )

Set the minimum value.

minValue The minimum value.

Definition at line 527 of file qgssettingsentry.cpp.

◆ settingsType()

QgsSettingsEntryBase::SettingsType QgsSettingsEntryInteger::settingsType ( ) const

overridevirtual

Returns the settings entry type.

Implements QgsSettingsEntryBase.

Definition at line 522 of file qgssettingsentry.cpp.

◆ setValue() [1/2]

bool QgsSettingsEntryInteger::setValue	(	qlonglong	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 475 of file qgssettingsentry.cpp.

◆ setValue() [2/2]

bool QgsSettingsEntryInteger::setValue	(	qlonglong	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 484 of file qgssettingsentry.cpp.

◆ value() [1/2]

qlonglong QgsSettingsEntryInteger::value	(	const QString &	dynamicKeyPart = `QString()`,
		bool	useDefaultValueOverride = `false`,
		qlonglong	defaultValueOverride = `0`
	)		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 507 of file qgssettingsentry.cpp.

◆ value() [2/2]

qlonglong QgsSettingsEntryInteger::value	(	const QStringList &	dynamicKeyPartList,
		bool	useDefaultValueOverride = `false`,
		qlonglong	defaultValueOverride = `0`
	)		const