QGIS API Documentation 3.29.0-Master (19d7edcfed)
Public Member Functions | List of all members
QgsSettingsEntryInteger Class Reference

An integer settings entry. More...

#include <qgssettingsentryimpl.h>

Inheritance diagram for QgsSettingsEntryInteger:
Inheritance graph
[legend]

Public Member Functions

 QgsSettingsEntryInteger (const QString &key, const QString &section, int defaultValue=0, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), int minValue=std::numeric_limits< int >::min(), int maxValue=std::numeric_limits< int >::max()) SIP_THROW(QgsSettingsException) SIP_MAKE_PRIVATE
 Constructor for QgsSettingsEntryInteger. More...
 
 QgsSettingsEntryInteger (const QString &key, QgsSettingsTreeNode *parent, int defaultValue=0, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), int minValue=std::numeric_limits< int >::min(), int maxValue=std::numeric_limits< int >::max()) SIP_THROW(QgsSettingsException)
 Constructor for QgsSettingsEntryInteger. More...
 
int maxValue () const
 Returns the maximum value. More...
 
int minValue () const
 Returns the minimum value. More...
 
virtual Qgis::SettingsType settingsType () const override
 Returns the settings entry type. More...
 
- Public Member Functions inherited from QgsSettingsEntryByValue< int >
 QgsSettingsEntryByValue (const QString &key, const QString &section, QVariant defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
 Constructor for QgsSettingsEntryByValue. More...
 
 QgsSettingsEntryByValue (const QString &key, QgsSettingsTreeNode *parent, QVariant defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
 Constructor for QgsSettingsEntryByValue. More...
 
int defaultValue () const
 Returns settings default value. More...
 
int formerValue (const QString &dynamicKeyPart=QString()) const
 Returns the former value Returns the current value (or default) if there is no former value. More...
 
int 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 (int value, const QString &dynamicKeyPart=QString()) const
 Set settings value. More...
 
bool setValue (int value, const QStringList &dynamicKeyPartList) const
 Set settings value. More...
 
Q_DECL_DEPRECATED int value (const QString &dynamicKeyPart, bool useDefaultValueOverride, int defaultValueOverride) const
 Returns the settings value for the dynamicKeyPart and with a defaultValueOverride. More...
 
int value (const QString &dynamicKeyPart=QString()) const
 Returns settings value. More...
 
int value (const QStringList &dynamicKeyPartList) const
 Returns settings value. More...
 
Q_DECL_DEPRECATED int value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, int defaultValueOverride) const
 Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride. More...
 
int valueWithDefaultOverride (int defaultValueOverride, const QString &dynamicKeyPart=QString()) const
 Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. More...
 
int valueWithDefaultOverride (int 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...
 
 QgsSettingsEntryBase (const QString &key, QgsSettingsTreeNode *parentTreeElement, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_THROW(QgsSettingsException)
 Constructor for QgsSettingsEntryBase. More...
 
virtual ~QgsSettingsEntryBase ()
 Destructor for QgsSettingsEntryBase. More...
 
bool copyValueFromKey (const QString &key, bool removeSettingAtKey=false) const
 Copies the value from a given key if it exists. More...
 
bool copyValueFromKey (const QString &key, const QStringList &dynamicKeyPartList, bool removeSettingAtKey=false) const
 Copies the value from a given key if it exists. More...
 
void copyValueToKey (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const
 Copies the settings to the given key. 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...
 
Qgis::SettingsOrigin origin (const QStringList &dynamicKeyPartList) const
 Returns the origin of the setting if it exists. More...
 
QgsSettingsTreeNodeparent () const
 Returns the parent tree element. 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 Qgis::SettingsType settingsType () const
 Returns the settings entry type. 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. More...
 
QVariant valueAsVariant (const QStringList &dynamicKeyPartList) const
 Returns settings value with. 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< int >
virtual bool checkValue (int value) const
 Check if the value is valid. More...
 
virtual int convertFromVariant (const QVariant &value) const=0
 Converts the variant value to the value type of the setting. More...
 
virtual QVariant convertToVariant (int value) const
 Converts the value to a variant. More...
 
virtual bool setValuePrivate (int 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 382 of file qgssettingsentryimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryInteger() [1/2]

QgsSettingsEntryInteger::QgsSettingsEntryInteger ( const QString &  key,
QgsSettingsTreeNode parent,
int  defaultValue = 0,
const QString &  description = QString(),
Qgis::SettingsOptions  options = Qgis::SettingsOptions(),
int  minValue = std::numeric_limits<int>::min(),
int  maxValue = std::numeric_limits<int>::max() 
)
inline

Constructor for QgsSettingsEntryInteger.

Parameters
keyspecifies the final part of the settings key.
parentspecifies the parent in the tree of settings.
defaultValuespecifies the default value for the settings entry.
descriptionspecifies a description for the settings entry.
optionsspecifies the options for the settings entry.
minValuespecifies the minimal value.
maxValuespecifies the maximal value.

Definition at line 397 of file qgssettingsentryimpl.h.

◆ QgsSettingsEntryInteger() [2/2]

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

Constructor for QgsSettingsEntryInteger.

Parameters
keyspecifies the final part of the settings key.
sectionspecifies the section.
defaultValuespecifies the default value for the settings entry.
descriptionspecifies a description for the settings entry.
optionsspecifies the options for the settings entry.
minValuespecifies the minimal value.
maxValuespecifies the maximal value.

Definition at line 420 of file qgssettingsentryimpl.h.

Member Function Documentation

◆ maxValue()

int QgsSettingsEntryInteger::maxValue ( ) const

Returns the maximum value.

Definition at line 122 of file qgssettingsentryimpl.cpp.

◆ minValue()

int QgsSettingsEntryInteger::minValue ( ) const

Returns the minimum value.

Definition at line 127 of file qgssettingsentryimpl.cpp.

◆ settingsType()

Qgis::SettingsType QgsSettingsEntryInteger::settingsType ( ) const
overridevirtual

Returns the settings entry type.

Implements QgsSettingsEntryByValue< int >.

Definition at line 117 of file qgssettingsentryimpl.cpp.


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