QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Member Functions | List of all members
QgsSettingsEntryBool Class Reference

A boolean settings entry. More...

#include <qgssettingsentryimpl.h>

Inheritance diagram for QgsSettingsEntryBool:
Inheritance graph
[legend]

Public Member Functions

 QgsSettingsEntryBool (const QString &key, const QString &section, bool defaultValue=false, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) SIP_MAKE_PRIVATE
 Constructor for QgsSettingsEntryBool. More...
 
virtual Qgis::SettingsType settingsType () const override
 Returns the settings entry type. More...
 
- Public Member Functions inherited from QgsSettingsEntryByValue< bool >
 QgsSettingsEntryByValue (const QString &key, const QString &section, QVariant defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
 Constructor for QgsSettingsEntryByValue. More...
 
bool defaultValue () const
 Returns settings default value. More...
 
bool formerValue (const QString &dynamicKeyPart=QString()) const
 Returns the former value Returns the current value (or default) if there is no former value. More...
 
bool 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 (bool value, const QString &dynamicKeyPart=QString()) const
 Set settings value. More...
 
bool setValue (bool value, const QStringList &dynamicKeyPartList) const
 Set settings value. More...
 
Q_DECL_DEPRECATED bool value (const QString &dynamicKeyPart, bool useDefaultValueOverride, bool defaultValueOverride) const
 Returns the settings value for the dynamicKeyPart and with a defaultValueOverride. More...
 
bool value (const QString &dynamicKeyPart=QString()) const
 Returns settings value. More...
 
bool value (const QStringList &dynamicKeyPartList) const
 Returns settings value. More...
 
Q_DECL_DEPRECATED bool value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, bool defaultValueOverride) const
 Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride. More...
 
bool valueWithDefaultOverride (bool defaultValueOverride, const QString &dynamicKeyPart=QString()) const
 Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. More...
 
bool valueWithDefaultOverride (bool 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 Qgis::SettingsType settingsType () const =0
 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 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< bool >
virtual bool checkValue (bool value) const
 Check if the value is valid. More...
 
virtual bool convertFromVariant (const QVariant &value) const=0
 Converts the variant value to the value type of the setting. More...
 
virtual QVariant convertToVariant (bool value) const
 Converts the value to a variant. More...
 
virtual bool setValuePrivate (bool 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

A boolean settings entry.

Since
QGIS 3.20

Definition at line 241 of file qgssettingsentryimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryBool()

QgsSettingsEntryBool::QgsSettingsEntryBool ( const QString &  key,
const QString &  section,
bool  defaultValue = false,
const QString &  description = QString(),
Qgis::SettingsOptions  options = Qgis::SettingsOptions() 
)
inline

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. The options arguments specifies the options for the settings entry.

Definition at line 254 of file qgssettingsentryimpl.h.

Member Function Documentation

◆ settingsType()

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

Returns the settings entry type.

Implements QgsSettingsEntryByValue< bool >.

Definition at line 97 of file qgssettingsentryimpl.cpp.


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