Class: QgsProcessingToolboxModel

A model for providers and algorithms shown within the Processing toolbox.

See QgsProcessingToolboxProxyModel for a sorted, filterable version of this model.

Added in version 3.4.

Class Hierarchy

Base classes

QAbstractItemModel
QObject

class qgis.gui.QgsProcessingToolboxModel

Bases: QAbstractItemModel

__init__(parent: QObject | None = None, registry: QgsProcessingRegistry | None = None, recentLog: QgsProcessingRecentAlgorithmLog | None = None, favoriteManager: QgsProcessingFavoriteAlgorithmManager | None = None)

Constructor for QgsProcessingToolboxModel, with the given parent object.

If registry is specified then the model will show providers and algorithms from the given registry. If no registry is specified, then the processing registry attached to QgsApplication.processingRegistry() will be used by the model.

If recentLog is specified then it will be used to create a “Recently used” top level group containing recently used algorithms.

If favoriteManager is specified then it will be used to create a “Favorites” top level group containing favorite algorithms. Since QGIS 3.40

Parameters:

• parent (Optional[QObject] = None)

• registry (Optional[QgsProcessingRegistry] = None)

• recentLog (Optional[QgsProcessingRecentAlgorithmLog] = None)

• favoriteManager (Optional[QgsProcessingFavoriteAlgorithmManager] = None)

class CustomRole(*values)

Bases: IntEnum

Custom model roles.

Note

Prior to QGIS 3.36 this was available as QgsProcessingToolboxModel.Roles

Added in version 3.36.

• NodeType: Corresponds to the node’s type

  Available as QgsProcessingToolboxModel.RoleNodeType in older QGIS releases.

• AlgorithmFlags: Returns the node’s algorithm flags, for algorithm nodes

  Available as QgsProcessingToolboxModel.RoleAlgorithmFlags in older QGIS releases.

• AlgorithmId: Algorithm ID, for algorithm nodes

  Available as QgsProcessingToolboxModel.RoleAlgorithmId in older QGIS releases.

• AlgorithmName: Untranslated algorithm name, for algorithm nodes

  Available as QgsProcessingToolboxModel.RoleAlgorithmName in older QGIS releases.

• AlgorithmShortDescription: Short algorithm description, for algorithm nodes

  Available as QgsProcessingToolboxModel.RoleAlgorithmShortDescription in older QGIS releases.

• AlgorithmTags: List of algorithm tags, for algorithm nodes

  Available as QgsProcessingToolboxModel.RoleAlgorithmTags in older QGIS releases.

• ProviderFlags: Returns the node’s provider flags

  Available as QgsProcessingToolboxModel.RoleProviderFlags in older QGIS releases.

• ParameterTypeId: Untranslated parameter type unique identifier for parameter nodes

  Added in version 3.44.

Roles

alias of CustomRole

algorithmForIndex(self, index: QModelIndex) → QgsProcessingAlgorithm | None

Returns the algorithm which corresponds to a given index, or None if the index does not represent an algorithm.

See also

isAlgorithm()

See also

providerForIndex()

Parameters:

index (QModelIndex)

Return type:

Optional[QgsProcessingAlgorithm]

signal favoriteAlgorithmAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

index2node(self, index: QModelIndex) → QgsProcessingToolboxModelNode | None

Returns the model node corresponding to the given index.

See also

node2index()

Parameters:

index (QModelIndex)

Return type:

Optional[QgsProcessingToolboxModelNode]

indexForProvider(self, providerId: str | None) → QModelIndex

Returns the index corresponding to the specified providerId.

See also

providerForIndex()

Parameters:

providerId (Optional[str])

Return type:

QModelIndex

indexOfParentTreeNode(self, parentNode: QgsProcessingToolboxModelNode | None) → QModelIndex

Returns the index corresponding to the parent of a given node.

Parameters:

parentNode (Optional[QgsProcessingToolboxModelNode])

Return type:

QModelIndex

isAlgorithm(self, index: QModelIndex) → bool

Returns True if index corresponds to an algorithm.

See also

algorithmForIndex()

Parameters:

index (QModelIndex)

Return type:

bool

isParameter(self, index: QModelIndex) → bool

Returns True if index corresponds to a parameter.

See also

parameterTypeForIndex()

Added in version 3.44.

Parameters:

index (QModelIndex)

Return type:

bool

node2index(self, node: QgsProcessingToolboxModelNode | None) → QModelIndex

Returns the model index corresponding to the given node.

See also

index2node()

Parameters:

node (Optional[QgsProcessingToolboxModelNode])

Return type:

QModelIndex

parameterTypeForIndex(self, index: QModelIndex) → QgsProcessingParameterType | None

Returns the algorithm which corresponds to a given index, or None if the index does not represent an algorithm.

See also

isParameter()

See also

providerForIndex()

Added in version 3.44.

Parameters:

index (QModelIndex)

Return type:

Optional[QgsProcessingParameterType]

providerForIndex(self, index: QModelIndex) → QgsProcessingProvider | None

Returns the provider which corresponds to a given index, or None if the index does not represent a provider.

See also

algorithmForIndex()

See also

indexForProvider()

Parameters:

index (QModelIndex)

Return type:

Optional[QgsProcessingProvider]

providerIdForIndex(self, index: QModelIndex) → str

Returns the provider ID which corresponds to a given index, or an empty string if the index does not represent a provider.

See also

algorithmForIndex()

See also

indexForProvider()

Parameters:

index (QModelIndex)

Return type:

str

signal recentAlgorithmAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.