An integer settings entry. More...

#include <qgssettingsentryimpl.h>

Inheritance diagram for QgsSettingsEntryInteger:

Public Member Functions
	QgsSettingsEntryInteger (const QString &key, const QString &section, qlonglong defaultValue=0, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), qlonglong minValue=std::numeric_limits< qlonglong >::min(), qlonglong maxValue=std::numeric_limits< qlonglong >::max()) SIP_MAKE_PRIVATE
	Constructor for QgsSettingsEntryInteger. More...

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

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

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

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

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

Public Member Functions inherited from QgsSettingsEntryByValue< qlonglong >
	QgsSettingsEntryByValue (const QString &key, const QString &section, QVariant defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
	Constructor for QgsSettingsEntryByValue. More...

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

qlonglong	formerValue (const QString &dynamicKeyPart=QString()) const
	Returns the former value Returns the current value (or default) if there is no former value. More...

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

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

Q_DECL_DEPRECATED qlonglong	value (const QString &dynamicKeyPart, bool useDefaultValueOverride, qlonglong defaultValueOverride) const
	Returns the settings value for the dynamicKeyPart and with a defaultValueOverride. More...

qlonglong	value (const QString &dynamicKeyPart=QString()) const
	Returns settings value. More...

qlonglong	value (const QStringList &dynamicKeyPartList) const
	Returns settings value. More...

Q_DECL_DEPRECATED qlonglong	value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, qlonglong defaultValueOverride) const
	Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride. More...

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

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

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

Detailed Description

An integer settings entry.

Since: QGIS 3.20

Definition at line 299 of file qgssettingsentryimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryInteger()

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

inline

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 options arguments specifies the options for the settings entry. The minValue argument specifies the minimal value. The maxValue argument specifies the maximal value.

Definition at line 314 of file qgssettingsentryimpl.h.

Member Function Documentation

◆ maxValue()

qlonglong QgsSettingsEntryInteger::maxValue ( ) const

Returns the maximum value.

Definition at line 149 of file qgssettingsentryimpl.cpp.

◆ minValue()

qlonglong QgsSettingsEntryInteger::minValue ( ) const

Returns the minimum value.

Definition at line 139 of file qgssettingsentryimpl.cpp.

◆ setMaxValue()

void QgsSettingsEntryInteger::setMaxValue ( qlonglong maxValue )

Set the maximum value.

maxValue The maximum value.

Definition at line 144 of file qgssettingsentryimpl.cpp.

◆ setMinValue()

void QgsSettingsEntryInteger::setMinValue ( qlonglong minValue )

Set the minimum value.

minValue The minimum value.

Definition at line 134 of file qgssettingsentryimpl.cpp.

◆ settingsType()

Qgis::SettingsType QgsSettingsEntryInteger::settingsType ( ) const

overridevirtual

Returns the settings entry type.

Implements QgsSettingsEntryBase.

Definition at line 129 of file qgssettingsentryimpl.cpp.

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

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

Public Member Functions

Additional Inherited Members