A string settings entry. More...
#include <qgssettingsentryimpl.h>
Inheritance diagram for QgsSettingsEntryString:
Public Member Functions | |
| QgsSettingsEntryString (const QString &key, const QString §ion, const QString &defaultValue=QString(), const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions(), int minLength=0, int maxLength=-1) SIP_MAKE_PRIVATE | |
| Constructor for QgsSettingsEntryString. More... | |
| int | maxLength () const |
| Returns the string maximum length. More... | |
| int | minLength () const |
| Returns the string minimum length. More... | |
| void | setMaxLength (int maxLength) |
| Set the string maximum length. More... | |
| void | setMinLength (int minLength) |
| Set the string minimum length. More... | |
| virtual Qgis::SettingsType | settingsType () const override |
| Returns the settings entry type. More... | |
 Public Member Functions inherited from QgsSettingsEntryByReference< QString > | |
| QgsSettingsEntryByReference (const QString &key, const QString §ion, const QString &defaultValue, const QString &description=QString(), Qgis::SettingsOptions options=Qgis::SettingsOptions()) | |
| Constructor for QgsSettingsEntryByReference. More... | |
| QString | defaultValue () const |
| Returns settings default value. More... | |
| QString | formerValue (const QString &dynamicKeyPart=QString()) const |
| Returns the former value. More... | |
| QString | 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 (const QString &value, const QString &dynamicKeyPart=QString()) const |
| Set settings value. More... | |
| bool | setValue (const QString &value, const QStringList &dynamicKeyPartList) const |
| Set settings value. More... | |
| Q_DECL_DEPRECATED QString | value (const QString &dynamicKeyPart, bool useDefaultValueOverride, const QString &defaultValueOverride) const |
| Returns the settings value for the dynamicKeyPart and with a defaultValueOverride. More... | |
| QString | value (const QString &dynamicKeyPart=QString()) const |
| Returns settings value. More... | |
| QString | value (const QStringList &dynamicKeyPartList) const |
| Returns settings value. More... | |
| Q_DECL_DEPRECATED QString | value (const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QString &defaultValueOverride) const |
| Returns the settings value for the dynamicKeyPartList and with a defaultValueOverride. More... | |
| QString | valueWithDefaultOverride (const QString &defaultValueOverride, const QString &dynamicKeyPart=QString()) const |
| Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart. More... | |
| QString | valueWithDefaultOverride (const QString &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 QgsSettingsEntryByReference< QString > | |
| virtual bool | checkValue (const QString &value) const |
| Check if the value is valid. More... | |
| virtual QString | convertFromVariant (const QVariant &value) const=0 |
| Converts the variant value to the value type of the setting. More... | |
| virtual QVariant | convertToVariant (const QString &value) const |
| Converts the value to a variant. More... | |
| bool | setValuePrivate (const QString &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
◆ QgsSettingsEntryString()
|
inline |
Constructor for QgsSettingsEntryString.
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 minLength argument specifies the minimal length of the string value. 0 means no limit. The maxLength argument specifies the maximal length of the string value. -1 means no limit.
Definition at line 102 of file qgssettingsentryimpl.h.
Member Function Documentation
◆ maxLength()
| int QgsSettingsEntryString::maxLength | ( | ) | const |
Returns the string maximum length.
By -1 there is no limitation.
Definition at line 73 of file qgssettingsentryimpl.cpp.
◆ minLength()
| int QgsSettingsEntryString::minLength | ( | ) | const |
Returns the string minimum length.
Definition at line 63 of file qgssettingsentryimpl.cpp.
◆ setMaxLength()
| void QgsSettingsEntryString::setMaxLength | ( | int | maxLength | ) |
Set the string maximum length.
maxLength The string maximum length.
Definition at line 68 of file qgssettingsentryimpl.cpp.
◆ setMinLength()
| void QgsSettingsEntryString::setMinLength | ( | int | minLength | ) |
Set the string minimum length.
minLength The string minimum length.
Definition at line 58 of file qgssettingsentryimpl.cpp.
◆ settingsType()
|
overridevirtual |
Returns the settings entry type.
Implements QgsSettingsEntryByReference< QString >.
Definition at line 53 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
