Class: QgsProcessingToolboxTreeView¶
- class qgis.gui.QgsProcessingToolboxTreeView¶
Bases:
PyQt5.QtWidgets.QTreeView
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.
QgsProcessingToolboxTreeView(parent: QWidget = None, registry:
QgsProcessingRegistry
= None, recentLog:QgsProcessingRecentAlgorithmLog
= None) Constructor forQgsProcessingToolboxTreeView
, with the specifiedparent
widget.If
registry
is set, then the view will automatically be populated with algorithms and providers from the registry. Otherwise, users must manually callsetRegistry()
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.Methods
Returns the algorithm at the specified tree view
index
, orNone
if the index does not correspond to an algorithm.columnCountChanged
columnResized
currentChanged
Returns the current filters controlling the view's contents.
- param event:
rowsAboutToBeRemoved
rowsInserted
rowsRemoved
scrollContentsBy
scrollDirtyRegion
Returns the currently selected algorithm in the tree view, or
None
if no algorithm is currently selected.selectionChanged
Sets a
filter
string, used to filter out the contents of the view to matching algorithms.Sets
filters
controlling the view's contents.Sets the vector
layer
for the in-place algorithmsSets the processing
registry
associated with the view.Sets the toolbox proxy model used to drive the view.
- actionEvent(self, QActionEvent)¶
- algorithmForIndex(self, index: QModelIndex) QgsProcessingAlgorithm ¶
Returns the algorithm at the specified tree view
index
, orNone
if the index does not correspond to an algorithm.- Parameters:
index (QModelIndex) –
- Return type:
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEditor(self, QWidget, QAbstractItemDelegate.EndEditHint)¶
- closeEvent(self, QCloseEvent)¶
- QgsProcessingToolboxTreeView.columnCountChanged(self, int, int)
- columnMoved(self)¶
- QgsProcessingToolboxTreeView.columnResized(self, int, int, int)
- commitData(self, QWidget)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- QgsProcessingToolboxTreeView.currentChanged(self, QModelIndex, QModelIndex)
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- dirtyRegionOffset(self) QPoint ¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- drawBranches(self, QPainter, QRect, QModelIndex)¶
- drawFrame(self, QPainter)¶
- drawRow(self, QPainter, QStyleOptionViewItem, QModelIndex)¶
- drawTree(self, QPainter, QRegion)¶
- dropEvent(self, QDropEvent)¶
- dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition ¶
- edit(self, QModelIndex)¶
- edit(self, QModelIndex, QAbstractItemView.EditTrigger, QEvent) bool
- editorDestroyed(self, QObject)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- eventFilter(self, QObject, QEvent) bool ¶
- executeDelayedItemsLayout(self)¶
- filters(self) QgsProcessingToolboxProxyModel.Filters ¶
Returns the current filters controlling the view’s contents.
See also
New in version 3.8.
- Return type:
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- horizontalOffset(self) int ¶
- horizontalScrollbarAction(self, int)¶
- horizontalScrollbarValueChanged(self, int)¶
- indexRowSizeHint(self, QModelIndex) int ¶
- initPainter(self, QPainter)¶
- initStyleOption(self, QStyleOptionFrame)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isIndexHidden(self, QModelIndex) bool ¶
- isSignalConnected(self, QMetaMethod) bool ¶
- keyPressEvent(self, event: QKeyEvent)¶
- Parameters:
event (QKeyEvent) –
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- moveCursor(self, QAbstractItemView.CursorAction, Union[Qt.KeyboardModifiers, Qt.KeyboardModifier]) QModelIndex ¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) Tuple[bool, int] ¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) int ¶
- reexpand(self)¶
- resizeEvent(self, QResizeEvent)¶
- rowHeight(self, QModelIndex) int ¶
- QgsProcessingToolboxTreeView.rowsAboutToBeRemoved(self, QModelIndex, int, int)
- QgsProcessingToolboxTreeView.rowsInserted(self, QModelIndex, int, int)
- QgsProcessingToolboxTreeView.rowsRemoved(self, QModelIndex, int, int)
- scheduleDelayedItemsLayout(self)¶
- QgsProcessingToolboxTreeView.scrollContentsBy(self, int, int)
- QgsProcessingToolboxTreeView.scrollDirtyRegion(self, int, int)
- selectedAlgorithm(self) QgsProcessingAlgorithm ¶
Returns the currently selected algorithm in the tree view, or
None
if no algorithm is currently selected.- Return type:
- selectedIndexes(self) List[QModelIndex] ¶
- QgsProcessingToolboxTreeView.selectionChanged(self, QItemSelection, QItemSelection)
- selectionCommand(self, QModelIndex, event: QEvent = None) QItemSelectionModel.SelectionFlags ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setDirtyRegion(self, QRegion)¶
- setFilterString(self, filter: str)¶
Sets a
filter
string, used to filter out the contents of the view to matching algorithms.- Parameters:
filter (str) –
- setFilters(self, filters: QgsProcessingToolboxProxyModel.Filters | QgsProcessingToolboxProxyModel.Filter)¶
Sets
filters
controlling the view’s contents.See also
- Parameters:
filters (Union[QgsProcessingToolboxProxyModel.Filters) –
- setInPlaceLayer(self, layer: QgsVectorLayer)¶
Sets the vector
layer
for the in-place algorithms- Parameters:
layer (QgsVectorLayer) –
- 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.- Parameters:
registry (QgsProcessingRegistry) –
recentLog (
QgsProcessingRecentAlgorithmLog
= None) –
- setSelection(self, QRect, Union[QItemSelectionModel.SelectionFlags, QItemSelectionModel.SelectionFlag])¶
- setState(self, QAbstractItemView.State)¶
- setToolboxProxyModel(self, model: QgsProcessingToolboxProxyModel)¶
Sets the toolbox proxy model used to drive the view.
- Parameters:
model (QgsProcessingToolboxProxyModel) –
- QgsProcessingToolboxTreeView.setViewportMargins(self, int, int, int, int)
- setViewportMargins(self, QMargins) None ¶
- showEvent(self, QShowEvent)¶
- sizeHintForColumn(self, int) int ¶
- startDrag(self, Union[Qt.DropActions, Qt.DropAction])¶
- state(self) QAbstractItemView.State ¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateEditorData(self)¶
- updateEditorGeometries(self)¶
- updateGeometries(self)¶
- updateMicroFocus(self)¶
- verticalOffset(self) int ¶
- verticalScrollbarAction(self, int)¶
- verticalScrollbarValueChanged(self, int)¶
- viewOptions(self) QStyleOptionViewItem ¶
- viewportEvent(self, QEvent) bool ¶
- viewportMargins(self) QMargins ¶
- viewportSizeHint(self) QSize ¶
- visualRegionForSelection(self, QItemSelection) QRegion ¶
- wheelEvent(self, QWheelEvent)¶