Class: QgsProcessingParameterEnum

An enum based parameter for processing algorithms, allowing for selection from predefined values.

Since QGIS 3.24 a list of icons corresponding to the enum values can be specified by setting the widget wrapper metadata “icons” option, as demonstrated below. The “icons” value should be set to a list of QIcon values.

param = QgsProcessingParameterEnum( 'FIELD_TYPE', 'Field type', ['Integer', 'String'])
param.setMetadata( {'widget_wrapper':
  { 'icons': [QIcon('integer.svg'), QIcon('string.svg')] }
})

Class Hierarchy

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Methods

allowMultiple	Returns True if the parameter allows multiple selected values.
options	Returns the list of acceptable options for the parameter.
setAllowMultiple	Sets whether the parameter allows multiple selected values.
setOptions	Sets the list of acceptable options for the parameter.
setUsesStaticStrings	Sets whether the parameter uses static (non-translated) string values for its enumeration choice list.
usesStaticStrings	Returns True if the parameter uses static (non-translated) string values for its enumeration choice list.

Static Methods

fromScriptCode	Creates a new parameter using the definition from a script code.
typeName	Returns the type name for the parameter class.

class qgis.core.QgsProcessingParameterEnum

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', options: Iterable[str | None] = [], allowMultiple: bool = False, defaultValue: Any = None, optional: bool = False, usesStaticStrings: bool = False)

Constructor for QgsProcessingParameterEnum.

Parameters:

• name (Optional[str])

• description (Optional[str] = '')

• options (Iterable[Optional[str]] = [])

• allowMultiple (bool = False)

• defaultValue (Any = None)

• optional (bool = False)

• usesStaticStrings (bool = False)

__init__(a0: QgsProcessingParameterEnum)

Parameters:

a0 (QgsProcessingParameterEnum)

allowMultiple(self) → bool

Returns True if the parameter allows multiple selected values.

See also

setAllowMultiple()

Return type:

bool

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterEnum | None

Creates a new parameter using the definition from a script code.

Parameters:

• name (Optional[str])

• description (Optional[str])

• isOptional (bool)

• definition (Optional[str])

Return type:

Optional[QgsProcessingParameterEnum]

options(self) → List[str]

Returns the list of acceptable options for the parameter.

See also

setOptions()

Return type:

List[str]

setAllowMultiple(self, allowMultiple: bool)

Sets whether the parameter allows multiple selected values.

See also

allowMultiple()

Parameters:

allowMultiple (bool)

setOptions(self, options: Iterable[str | None])

Sets the list of acceptable options for the parameter.

See also

options()

Parameters:

options (Iterable[Optional[str]])

setUsesStaticStrings(self, usesStaticStrings: bool)

Sets whether the parameter uses static (non-translated) string values for its enumeration choice list.

See also

usesStaticStrings()

Added in version 3.18.

Parameters:

usesStaticStrings (bool)

static typeName() → str

Returns the type name for the parameter class.

Return type:

str

usesStaticStrings(self) → bool

Returns True if the parameter uses static (non-translated) string values for its enumeration choice list.

See also

setUsesStaticStrings()

Added in version 3.18.

Return type:

bool