A double settings entry. More...
#include <qgssettingsentryimpl.h>
Inheritance diagram for QgsSettingsEntryDouble:
Public Member Functions | |
| QgsSettingsEntryDouble (const QString &key, const QString §ion, double defaultValue=0.0, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), double minValue=std::numeric_limits< double >::lowest(), double maxValue=std::numeric_limits< double >::max(), int displayDecimals=1) SIP_MAKE_PRIVATE | |
| Constructor for QgsSettingsEntryDouble. More... | |
| int | displayHintDecimals () const |
| Returns how much decimals should be shown in the Gui. More... | |
| double | maxValue () const |
| Returns the maximum value. More... | |
| double | minValue () const |
| Returns the minimum value. More... | |
| void | setDisplayHintDecimals (int displayHintDecimals) |
| Set the display hint decimals. More... | |
| void | setMaxValue (double maxValue) |
| Set the maximum value. More... | |
| void | setMinValue (double minValue) |
| Set the minimum value. More... | |
| virtual Qgis::SettingsType | settingsType () const override |
| Returns the settings entry type. More... | |
 Public Member Functions inherited from QgsSettingsEntryByValue< double > | |
| QgsSettingsEntryByValue (const QString &key, const QString §ion, QVariant defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
| Constructor for QgsSettingsEntryByValue. More... | |
| double | defaultValue () const |
| Returns settings default value. More... | |
| double | formerValue (const QString &dynamicKeyPart=QString()) const |
| Returns the former value Returns the current value (or default) if there is no former value. More... | |
| double | 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 (double value, const QString &dynamicKeyPart=QString()) const |
| Set settings value. More... | |
| bool | setValue (double value, const QStringList &dynamicKeyPartList) const |
| Set settings value. More... | |
| Q_DECL_DEPRECATED double | value (const QString &dynamicKeyPart, bool useDefaultValueOverride, double defaultValueOverride) const |
| Returns the settings value for the dynamicKeyPart and with a defaultValueOverride. More... | |
| double | value (const QString &dynamicKeyPart=QString()) const |
| Returns settings value. More... | |
| double | value (const QStringList &dynamicKeyPartList) const |
| Returns settings value. More... | |
| Q_DECL_DEPRECATED double | value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, double defaultValueOverride) const |
| Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride. More... | |
| double | valueWithDefaultOverride (double defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
| Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. More... | |
| double | valueWithDefaultOverride (double 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 §ion, 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< double > | |
| virtual bool | checkValue (double value) const |
| Check if the value is valid. More... | |
| virtual double | convertFromVariant (const QVariant &value) const=0 |
| Converts the variant value to the value type of the setting. More... | |
| virtual QVariant | convertToVariant (double value) const |
| Converts the value to a variant. More... | |
| virtual bool | setValuePrivate (double 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
Constructor & Destructor Documentation
◆ QgsSettingsEntryDouble()
|
inline |
Constructor for QgsSettingsEntryDouble.
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. The displayDecimals specifies an hint for the gui about how much decimals to show for example for a QDoubleSpinBox.
Definition at line 411 of file qgssettingsentryimpl.h.
Member Function Documentation
◆ displayHintDecimals()
| int QgsSettingsEntryDouble::displayHintDecimals | ( | ) | const |
Returns how much decimals should be shown in the Gui.
Definition at line 213 of file qgssettingsentryimpl.cpp.
◆ maxValue()
| double QgsSettingsEntryDouble::maxValue | ( | ) | const |
Returns the maximum value.
Definition at line 203 of file qgssettingsentryimpl.cpp.
◆ minValue()
| double QgsSettingsEntryDouble::minValue | ( | ) | const |
Returns the minimum value.
Definition at line 193 of file qgssettingsentryimpl.cpp.
◆ setDisplayHintDecimals()
| void QgsSettingsEntryDouble::setDisplayHintDecimals | ( | int | displayHintDecimals | ) |
Set the display hint decimals.
displayHintDecimals The number of decimals that should be shown in the Gui.
Definition at line 208 of file qgssettingsentryimpl.cpp.
◆ setMaxValue()
| void QgsSettingsEntryDouble::setMaxValue | ( | double | maxValue | ) |
Set the maximum value.
maxValue The maximum value.
Definition at line 198 of file qgssettingsentryimpl.cpp.
◆ setMinValue()
| void QgsSettingsEntryDouble::setMinValue | ( | double | minValue | ) |
Set the minimum value.
minValue The minimum value.
Definition at line 188 of file qgssettingsentryimpl.cpp.
◆ settingsType()
|
overridevirtual |
Returns the settings entry type.
Implements QgsSettingsEntryByValue< double >.
Definition at line 183 of file qgssettingsentryimpl.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.28.0+99sid/src/core/settings/qgssettingsentryimpl.h
- /build/qgis-3.28.0+99sid/src/core/settings/qgssettingsentryimpl.cpp
