Skip to content

Commit

Permalink
make params easier to find in PyQgsSettingsEntryEnumFlag docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DelazJ authored and 3nids committed Dec 16, 2022
1 parent 378347a commit d249049
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions python/core/additions/qgssettingsentry.py
Expand Up @@ -32,6 +32,7 @@ class PyQgsSettingsEntryEnumFlag
def __init__(self, key, pluginName, defaultValue, description=str(), options=Qgis.SettingsOptions()):
"""
Constructor for PyQgsSettingsEntryEnumFlag.
:param key: argument specifies the final part of the settings key.
:param pluginName: argument is inserted in the key after the section.
:param defaultValue: argument specifies the default value for the settings entry.
Expand All @@ -55,6 +56,7 @@ def __init__(self, key, pluginName, defaultValue, description=str(), options=Qgi
def value(self, dynamicKeyPart=None):
"""
Get settings value.
:param dynamicKeyPart: argument specifies the dynamic part of the settings key.
"""
if self.__metaEnum.isFlag():
Expand All @@ -65,6 +67,7 @@ def value(self, dynamicKeyPart=None):
def valueWithDefaultOverride(self, defaultValueOverride, dynamicKeyPart=None):
"""
Get settings value with a default value override.
:param defaultValueOverride: argument if valid is used instead of the normal default value.
:param dynamicKeyPart: argument specifies the dynamic part of the settings key.
"""
Expand Down Expand Up @@ -98,6 +101,7 @@ def defaultValue(self):
def setValue(self, value, dynamicKeyPart: (list, str) = None):
"""
Set settings value.
:param value: the value to set for the setting.
:param dynamicKeyPart: argument specifies the dynamic part of the settings key (a single one a string, or several as a list)
"""
Expand Down

0 comments on commit d249049

Please sign in to comment.