Class: QgsProcessingToolboxModel

class qgis.gui.QgsProcessingToolboxModel

Bases: PyQt5.QtCore.QAbstractItemModel

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

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

New in version 3.4.

QgsProcessingToolboxModel(parent: QObject = None, registry: QgsProcessingRegistry = None, recentLog: QgsProcessingRecentAlgorithmLog = 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.

Methods

algorithmForIndex

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

beginInsertColumns

beginInsertRows

beginMoveColumns

beginMoveRows

beginRemoveColumns

beginRemoveRows

beginResetModel

changePersistentIndex

changePersistentIndexList

childEvent

columnCount

rtype

int

connectNotify

createIndex

customEvent

data

param index

decodeData

disconnectNotify

encodeData

endInsertColumns

endInsertRows

endMoveColumns

endMoveRows

endRemoveColumns

endRemoveRows

endResetModel

flags

param index

index

param row

index2node

Returns the model node corresponding to the given index.

indexForProvider

Returns the index corresponding to the specified providerId.

indexOfParentTreeNode

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

isAlgorithm

Returns True if index corresponds to an algorithm.

isSignalConnected

mimeData

param indexes

node2index

Returns the model index corresponding to the given node.

parent

param index

persistentIndexList

providerForIndex

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

providerIdForIndex

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

receivers

resetInternalData

rowCount

param parent

sender

senderSignalIndex

timerEvent

Signals

recentAlgorithmAdded

Emitted whenever recent algorithms are added to the model.

Attributes

RoleAlgorithmFlags

RoleAlgorithmId

RoleAlgorithmName

RoleAlgorithmShortDescription

RoleAlgorithmTags

RoleNodeType

RoleProviderFlags

RoleAlgorithmFlags = 257
RoleAlgorithmId = 258
RoleAlgorithmName = 259
RoleAlgorithmShortDescription = 260
RoleAlgorithmTags = 261
RoleNodeType = 256
RoleProviderFlags = 262
class Roles

Bases: int

algorithmForIndex(self, index: QModelIndex)QgsProcessingAlgorithm

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

See also

isAlgorithm()

Parameters

index (QModelIndex) –

Return type

QgsProcessingAlgorithm

QgsProcessingToolboxModel.beginInsertColumns(self, QModelIndex, int, int)
QgsProcessingToolboxModel.beginInsertRows(self, QModelIndex, int, int)
QgsProcessingToolboxModel.beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) -> bool
QgsProcessingToolboxModel.beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) -> bool
QgsProcessingToolboxModel.beginRemoveColumns(self, QModelIndex, int, int)
QgsProcessingToolboxModel.beginRemoveRows(self, QModelIndex, int, int)
beginResetModel(self)
QgsProcessingToolboxModel.changePersistentIndex(self, QModelIndex, QModelIndex)
changePersistentIndexList(self, Iterable[QModelIndex], Iterable[QModelIndex])
childEvent(self, QChildEvent)
columnCount(self, QModelIndex=QModelIndex())int
Return type

int

connectNotify(self, QMetaMethod)
QgsProcessingToolboxModel.createIndex(self, int, int, object: object = 0) -> QModelIndex
customEvent(self, QEvent)
data(self, index: QModelIndex, role: int = Qt.DisplayRole)Any
Parameters
  • index (QModelIndex) –

  • role (int = Qt.DisplayRole) –

Return type

Any

QgsProcessingToolboxModel.decodeData(self, int, int, QModelIndex, QDataStream) -> bool
disconnectNotify(self, QMetaMethod)
encodeData(self, Iterable[QModelIndex], QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
flags(self, index: QModelIndex)Qt.ItemFlags
Parameters

index (QModelIndex) –

Return type

Qt.ItemFlags

index(self, row: int, column: int, parent: QModelIndex = QModelIndex())QModelIndex
Parameters
  • row (int) –

  • column (int) –

  • parent (QModelIndex = QModelIndex()) –

Return type

QModelIndex

index2node(self, index: QModelIndex)QgsProcessingToolboxModelNode

Returns the model node corresponding to the given index.

See also

node2index()

Parameters

index (QModelIndex) –

Return type

QgsProcessingToolboxModelNode

indexForProvider(self, providerId: str)QModelIndex

Returns the index corresponding to the specified providerId.

Parameters

providerId (str) –

Return type

QModelIndex

indexOfParentTreeNode(self, parentNode: QgsProcessingToolboxModelNode)QModelIndex

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

Parameters

parentNode (QgsProcessingToolboxModelNode) –

Return type

QModelIndex

isAlgorithm(self, index: QModelIndex)bool

Returns True if index corresponds to an algorithm.

Parameters

index (QModelIndex) –

Return type

bool

isSignalConnected(self, QMetaMethod)bool
mimeData(self, indexes: Iterable[QModelIndex])QMimeData
Parameters

indexes (Iterable[QModelIndex]) –

Return type

QMimeData

node2index(self, node: QgsProcessingToolboxModelNode)QModelIndex

Returns the model index corresponding to the given node.

See also

index2node()

Parameters

node (QgsProcessingToolboxModelNode) –

Return type

QModelIndex

parent(self, index: QModelIndex)QModelIndex
Parameters

index (QModelIndex) –

Return type

QModelIndex

persistentIndexList(self)List[QModelIndex]
providerForIndex(self, index: QModelIndex)QgsProcessingProvider

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

Parameters

index (QModelIndex) –

Return type

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.

Parameters

index (QModelIndex) –

Return type

str

receivers(self, PYQT_SIGNAL)int
recentAlgorithmAdded

Emitted whenever recent algorithms are added to the model. [signal]

resetInternalData(self)
rowCount(self, parent: QModelIndex = QModelIndex())int
Parameters

parent (QModelIndex = QModelIndex()) –

Return type

int

sender(self)QObject
senderSignalIndex(self)int
timerEvent(self, QTimerEvent)