QGIS API Documentation 3.37.0-Master (c2d15952569)
Loading...
Searching...
No Matches
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())
 Constructor for QgsSettingsEntryBool.
 
 QgsSettingsEntryBool (const QString &name, QgsSettingsTreeNode *parent, bool defaultValue=false, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
 Constructor for QgsSettingsEntryBool.
 
bool convertFromVariant (const QVariant &value) const override
 Converts the variant value to the value type of the setting.
 
virtual Qgis::SettingsType settingsType () const override
 Returns the settings entry type.
 
- Public Member Functions inherited from QgsSettingsEntryBaseTemplate< bool >
 QgsSettingsEntryBaseTemplate (const QString &key, const QString &section, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
 Constructor for QgsSettingsEntryByReference.
 
 QgsSettingsEntryBaseTemplate (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
 Constructor for QgsSettingsEntryByReference.
 
bool checkValueVariant (const QVariant &value) const override
 Returns true if the given value is valid towards the setting definition.
 
bool defaultValue () const
 Returns settings default value.
 
bool formerValue (const QString &dynamicKeyPart=QString()) const
 Returns the former value.
 
bool formerValue (const QStringList &dynamicKeyPartList) const
 Returns the former value Returns the current value (or default) if there is no former value.
 
bool setValue (const bool &value, const QString &dynamicKeyPart=QString()) const
 Set settings value.
 
bool setValue (const bool &value, const QStringList &dynamicKeyPartList) const
 Set settings value.
 
bool value (const QString &dynamicKeyPart=QString()) const
 Returns settings value.
 
bool value (const QStringList &dynamicKeyPartList) const
 Returns settings value.
 
bool valueWithDefaultOverride (const bool &defaultValueOverride, const QString &dynamicKeyPart=QString()) const
 Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart.
 
bool valueWithDefaultOverride (const bool &defaultValueOverride, const QStringList &dynamicKeyPartList) const
 Returns the settings value with a defaultValueOverride for the dynamicKeyPartList.
 
- 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.
 
 QgsSettingsEntryBase (const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue=QVariant(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions())
 Constructor for QgsSettingsEntryBase.
 
virtual ~QgsSettingsEntryBase ()
 Destructor for QgsSettingsEntryBase.
 
bool copyValueFromKey (const QString &key, bool removeSettingAtKey=false) const
 Copies the value from a given key if it exists.
 
bool copyValueFromKey (const QString &key, const QStringList &dynamicKeyPartList, bool removeSettingAtKey=false) const
 Copies the value from a given key if it exists.
 
void copyValueToKey (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const
 Copies the settings to the given key.
 
void copyValueToKeyIfChanged (const QString &key, const QStringList &dynamicKeyPartList=QStringList()) const
 Copies the settings to the given key, if it has changed during the current QGIS session (see hasChanged()).
 
QVariant defaultValueAsVariant () const
 Returns settings default value.
 
QString definitionKey () const
 Returns settings entry defining key.
 
QString description () const
 Returns the settings entry description.
 
bool exists (const QString &dynamicKeyPart=QString()) const
 Returns true if the settings is contained in the underlying QSettings.
 
bool exists (const QStringList &dynamicKeyPartList) const
 Returns true if the settings is contained in the underlying QSettings.
 
QVariant formerValueAsVariant (const QString &dynamicKeyPart) const
 Returns the former value of the settings if it has been enabled in the options.
 
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.
 
bool hasChanged () const
 Returns true if the setting was changed during the current QGIS session.
 
bool hasDynamicKey () const
 Returns true if a part of the settings key is built dynamically.
 
QString key (const QString &dynamicKeyPart=QString()) const
 Returns settings entry key.
 
QString key (const QStringList &dynamicKeyPartList) const
 Returns settings entry key.
 
bool keyIsValid (const QString &key) const
 Returns true if the provided key match the settings entry.
 
QString name () const
 Returns the name of the settings.
 
Qgis::SettingsOptions options () const
 Returns the settings options.
 
Qgis::SettingsOrigin origin (const QStringList &dynamicKeyPartList) const
 Returns the origin of the setting if it exists.
 
QgsSettingsTreeNodeparent () const
 Returns the parent tree element.
 
void remove (const QString &dynamicKeyPart=QString()) const
 Removes the settings from the underlying QSettings.
 
void remove (const QStringList &dynamicKeyPartList) const
 Removes the settings from the underlying QSettings.
 
Q_DECL_DEPRECATED int section () const
 Returns settings section.
 
bool setVariantValue (const QVariant &value, const QString &dynamicKeyPart=QString()) const
 Set settings value.
 
bool setVariantValue (const QVariant &value, const QStringList &dynamicKeyPartList) const
 Set settings value.
 
virtual QString typeId () const
 Returns the id of the type of settings This can be re-implemented in a custom implementation of a setting.
 
Q_DECL_DEPRECATED QVariant valueAsVariant (const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const
 Returns settings value with an optional default value override.
 
QVariant valueAsVariant (const QString &dynamicKeyPart=QString()) const
 Returns settings value with.
 
QVariant valueAsVariant (const QStringList &dynamicKeyPartList) const
 Returns settings value with.
 
Q_DECL_DEPRECATED QVariant valueAsVariant (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride) const
 Returns settings value with an optional default value override.
 
QVariant valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QString &dynamicKeyPart=QString()) const
 Returns settings value with a defaultValueOverride.
 
QVariant valueAsVariantWithDefaultOverride (const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList) const
 Returns settings value.
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsSettingsEntryBase
static QStringList dynamicKeyPartToList (const QString &dynamicKeyPart)
 Transforms a dynamic key part string to list.
 
- Protected Member Functions inherited from QgsSettingsEntryBaseTemplate< bool >
virtual bool checkValuePrivate (const bool &value) const
 Check if the value is valid.
 
virtual QVariant convertToVariant (const bool &value) const
 Converts the value to a variant.
 
virtual bool setValuePrivate (const bool &value, const QStringList &dynamicKeyPartList) const
 Sets the settings value with an optional list of dynamic parts.
 

Detailed Description

A boolean settings entry.

Since
QGIS 3.20

Definition at line 304 of file qgssettingsentryimpl.h.

Constructor & Destructor Documentation

◆ QgsSettingsEntryBool() [1/2]

QgsSettingsEntryBool::QgsSettingsEntryBool ( const QString &  name,
QgsSettingsTreeNode parent,
bool  defaultValue = false,
const QString &  description = QString(),
Qgis::SettingsOptions  options = Qgis::SettingsOptions() 
)
inline

Constructor for QgsSettingsEntryBool.

Parameters
namespecifies the name of the setting.
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.

Definition at line 317 of file qgssettingsentryimpl.h.

◆ QgsSettingsEntryBool() [2/2]

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

Constructor for QgsSettingsEntryBool.

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.

Definition at line 334 of file qgssettingsentryimpl.h.

Member Function Documentation

◆ convertFromVariant()

bool QgsSettingsEntryBool::convertFromVariant ( const QVariant &  value) const
overridevirtual

Converts the variant value to the value type of the setting.

Implements QgsSettingsEntryBaseTemplate< bool >.

Definition at line 80 of file qgssettingsentryimpl.cpp.

◆ settingsType()

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

Returns the settings entry type.

Implements QgsSettingsEntryBaseTemplate< bool >.

Definition at line 86 of file qgssettingsentryimpl.cpp.


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