Class: QgsProcessingToolboxProxyModel¶
-
class
qgis.gui.
QgsProcessingToolboxProxyModel
(parent: QObject = None, registry: QgsProcessingRegistry = None, recentLog: QgsProcessingRecentAlgorithmLog = None)¶ Bases:
PyQt5.QtCore.QSortFilterProxyModel
Constructor for QgsProcessingToolboxProxyModel, 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.A sort/filter proxy model for providers and algorithms shown within the Processing toolbox, which automatically sorts the toolbox in a logical fashion and supports filtering the results.
New in version 3.4: Enums
Methods
Returns the current filter string, if set.
Returns any filters that affect how toolbox content is filtered.
Sets a
filter
string, such that only algorithms matching the specified string will be shown.Set
filters
that affect how toolbox content is filtered.Sets the vector
layer
for in-place algorithm filterReturns the underlying source Processing toolbox model.
Signals
Attributes
-
class
Filter
¶ Bases:
int
-
FilterInPlace
= 8¶
-
FilterModeler
= 4¶
-
FilterShowKnownIssues
= 16¶
-
FilterToolbox
= 2¶
-
class
Filters
¶ Bases:
sip.wrapper
QgsProcessingToolboxProxyModel.Filters(Union[QgsProcessingToolboxProxyModel.Filters, QgsProcessingToolboxProxyModel.Filter]) QgsProcessingToolboxProxyModel.Filters(QgsProcessingToolboxProxyModel.Filters)
-
baseClass
¶ alias of
QgsProcessingToolboxProxyModel
-
-
beginInsertColumns
()¶
-
beginInsertRows
()¶
-
beginMoveColumns
()¶
-
beginMoveRows
()¶
-
beginRemoveColumns
()¶
-
beginRemoveRows
()¶
-
beginResetModel
()¶
-
changePersistentIndex
()¶
-
changePersistentIndexList
()¶
-
childEvent
()¶
-
connectNotify
()¶
-
createIndex
()¶
-
customEvent
()¶
-
decodeData
()¶
-
disconnectNotify
()¶
-
encodeData
()¶
-
endInsertColumns
()¶
-
endInsertRows
()¶
-
endMoveColumns
()¶
-
endMoveRows
()¶
-
endRemoveColumns
()¶
-
endRemoveRows
()¶
-
endResetModel
()¶
-
filterAcceptsColumn
()¶
-
filterAcceptsRow
(self, sourceRow: int, sourceParent: QModelIndex) → bool¶
-
filterString
(self) → str¶ Returns the current filter string, if set.
See also
-
filters
(self) → QgsProcessingToolboxProxyModel.Filters¶ Returns any filters that affect how toolbox content is filtered.
See also
-
invalidateFilter
()¶
-
isSignalConnected
()¶
-
lessThan
(self, left: QModelIndex, right: QModelIndex) → bool¶
-
persistentIndexList
()¶
-
receivers
()¶
-
resetInternalData
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setFilterString
(self, filter: str)¶ Sets a
filter
string, such that only algorithms matching the specified string will be shown.Matches are performed using a variety of tests, including checking against the algorithm name, short description, tags, etc.
See also
-
setFilters
(self, filters: Union[QgsProcessingToolboxProxyModel.Filters, QgsProcessingToolboxProxyModel.Filter])¶ Set
filters
that affect how toolbox content is filtered.See also
-
setInPlaceLayer
(self, layer: QgsVectorLayer)¶ Sets the vector
layer
for in-place algorithm filter
-
timerEvent
()¶
-
toolboxModel
(self) → QgsProcessingToolboxModel¶ Returns the underlying source Processing toolbox model.
-
class