Subgroup: Processing

Class: QgsProcessingToolboxTreeView

class qgis.gui.QgsProcessingToolboxTreeView(parent: QWidget = None, registry: QgsProcessingRegistry = None, recentLog: QgsProcessingRecentAlgorithmLog = None)

Bases: PyQt5.QtWidgets.QTreeView

Constructor for QgsProcessingToolboxTreeView, with the specified parent widget.

If registry is set, then the view will automatically be populated with algorithms and providers from the registry. Otherwise, users must manually call setRegistry() to associate a registry with the view.

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

Processing toolbox tree view, showing algorithms and providers in a tree structure.

Warning

Not part of stable API and may change in future QGIS releases.

New in version 3.4: Methods

actionEvent
algorithmForIndex Returns the algorithm at the specified tree view index, or a None if the index does not correspond to an algorithm.
changeEvent
childEvent
closeEditor
closeEvent
columnCountChanged
columnMoved
columnResized
commitData
connectNotify
contextMenuEvent
create
currentChanged
customEvent
destroy
dirtyRegionOffset
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
drawBranches
drawFrame
drawRow
drawTree
dropEvent
dropIndicatorPosition
edit
editorDestroyed
enterEvent
event
eventFilter
executeDelayedItemsLayout
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
horizontalOffset
horizontalScrollbarAction
horizontalScrollbarValueChanged
indexRowSizeHint
initPainter
initStyleOption
inputMethodEvent
isIndexHidden
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveCursor
moveEvent
nativeEvent
paintEvent
receivers
reexpand
resizeEvent
rowHeight
rowsAboutToBeRemoved
rowsInserted
rowsRemoved
scheduleDelayedItemsLayout
scrollContentsBy
scrollDirtyRegion
selectedAlgorithm Returns the currently selected algorithm in the tree view, or a None if no algorithm is currently selected.
selectedIndexes
selectionChanged
selectionCommand
sender
senderSignalIndex
setDirtyRegion
setFilterString Sets a filter string, used to filter out the contents of the view to matching algorithms.
setFilters Sets filters controlling the view’s contents.
setRegistry Sets the processing registry associated with the view.
setSelection
setState
setToolboxProxyModel Sets the toolbox proxy model used to drive the view.
setViewportMargins
sharedPainter
showEvent
sizeHintForColumn
startDrag
state
tabletEvent
timerEvent
updateEditorData
updateEditorGeometries
updateGeometries
updateMicroFocus
verticalOffset
verticalScrollbarAction
verticalScrollbarValueChanged
viewOptions
viewportEvent
viewportMargins
viewportSizeHint
visualRegionForSelection
wheelEvent

Signals

Attributes

actionEvent()
algorithmForIndex(self, index: QModelIndex) → QgsProcessingAlgorithm

Returns the algorithm at the specified tree view index, or a None if the index does not correspond to an algorithm.

changeEvent()
childEvent()
closeEditor()
closeEvent()
columnCountChanged()
columnMoved()
columnResized()
commitData()
connectNotify()
contextMenuEvent()
create()
currentChanged()
customEvent()
destroy()
dirtyRegionOffset()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
drawBranches()
drawFrame()
drawRow()
drawTree()
dropEvent()
dropIndicatorPosition()
edit()
editorDestroyed()
enterEvent()
event()
eventFilter()
executeDelayedItemsLayout()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
horizontalOffset()
horizontalScrollbarAction()
horizontalScrollbarValueChanged()
indexRowSizeHint()
initPainter()
initStyleOption()
inputMethodEvent()
isIndexHidden()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveCursor()
moveEvent()
nativeEvent()
paintEvent()
receivers()
reexpand()
resizeEvent()
rowHeight()
rowsAboutToBeRemoved()
rowsInserted()
rowsRemoved()
scheduleDelayedItemsLayout()
scrollContentsBy()
scrollDirtyRegion()
selectedAlgorithm(self) → QgsProcessingAlgorithm

Returns the currently selected algorithm in the tree view, or a None if no algorithm is currently selected.

selectedIndexes()
selectionChanged()
selectionCommand()
sender()
senderSignalIndex()
setDirtyRegion()
setFilterString(self, filter: str)

Sets a filter string, used to filter out the contents of the view to matching algorithms.

setFilters(self, filters: Union[QgsProcessingToolboxProxyModel.Filters, QgsProcessingToolboxProxyModel.Filter])

Sets filters controlling the view’s contents.

setRegistry(self, registry: QgsProcessingRegistry, recentLog: QgsProcessingRecentAlgorithmLog = None)

Sets the processing registry associated with the view.

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

setSelection()
setState()
setToolboxProxyModel(self, model: QgsProcessingToolboxProxyModel)

Sets the toolbox proxy model used to drive the view.

setViewportMargins()
sharedPainter()
showEvent()
sizeHintForColumn()
startDrag()
state()
tabletEvent()
timerEvent()
updateEditorData()
updateEditorGeometries()
updateGeometries()
updateMicroFocus()
verticalOffset()
verticalScrollbarAction()
verticalScrollbarValueChanged()
viewOptions()
viewportEvent()
viewportMargins()
viewportSizeHint()
visualRegionForSelection()
wheelEvent()