Subgroup: Layer

Class: QgsLayerTreeView¶

class qgis.gui.QgsLayerTreeView¶

Bases: PyQt5.QtWidgets.QTreeView

The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working with a layer tree.

The view updates expanded state of layer tree nodes and also listens to changes to expanded states in the layer tree.

The view keeps track of the current layer and emits a signal when the current layer has changed.

Allows the client to specify a context menu provider with custom actions. Also it comes with a set of default actions that can be used when building context menu.

See also

QgsLayerTreeModel

New in version 2.4: Methods

`acceptDrops`
`accessibleDescription`
`accessibleName`
`actionEvent`
`actions`
`activateWindow`
`addAction`
`addActions`
`addScrollBarWidget`
`adjustSize`
`allColumnsShowFocus`
`alternatingRowColors`
`autoExpandDelay`
`autoFillBackground`
`autoScrollMargin`
`backgroundRole`
`baseSize`
`blockSignals`
`changeEvent`
`childAt`	childAt(self, int, int) -> QWidget
`childEvent`
`children`
`childrenRect`
`childrenRegion`
`clearFocus`
`clearMask`
`clearSelection`
`close`
`closeEditor`
`closeEvent`
`closePersistentEditor`
`collapse`
`collapseAll`
`collapseAllNodes`	Enhancement of QTreeView.collapseAll() that also records expanded state in layer tree nodes
`colorCount`
`columnAt`
`columnCountChanged`
`columnMoved`
`columnResized`
`columnViewportPosition`
`columnWidth`
`commitData`
`connectNotify`
`contentsMargins`
`contentsRect`
`contextMenuEvent`
`contextMenuPolicy`
`cornerWidget`
`create`
`createWindowContainer`
`currentChanged`
`currentGroupNode`	Get current group node.
`currentIndex`
`currentLayer`	Get currently selected layer.
`currentLegendNode`	Get current legend node.
`currentNode`	Get current node.
`cursor`
`customEvent`
`dataChanged`
`defaultActions`	Get access to the default actions that may be used with the tree view
`defaultDropAction`
`deleteLater`
`depth`
`destroy`
`devType`
`devicePixelRatio`
`devicePixelRatioF`
`devicePixelRatioFScale`
`dirtyRegionOffset`
`disconnect`
`disconnectNotify`
`dragDropMode`
`dragDropOverwriteMode`
`dragEnabled`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`drawBranches`
`drawFrame`
`drawRow`
`drawTree`
`dropEvent`
`dropIndicatorPosition`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`edit`
`editTriggers`
`editorDestroyed`
`effectiveWinId`
`ensurePolished`
`enterEvent`
`event`
`eventFilter`
`executeDelayedItemsLayout`
`expand`
`expandAll`
`expandAllNodes`	Enhancement of QTreeView.expandAll() that also records expanded state in layer tree nodes
`expandToDepth`
`expandsOnDoubleClick`
`find`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPolicy`
`focusPreviousChild`
`focusProxy`
`focusWidget`
`font`
`fontInfo`
`fontMetrics`
`foregroundRole`
`frameGeometry`
`frameRect`
`frameShadow`
`frameShape`
`frameSize`
`frameStyle`
`frameWidth`
`geometry`
`getContentsMargins`
`grab`
`grabGesture`
`grabKeyboard`
`grabMouse`	grabMouse(self, Union[QCursor, Qt.CursorShape])
`grabShortcut`
`graphicsEffect`
`graphicsProxyWidget`
`hasAutoScroll`
`hasFocus`
`hasHeightForWidth`
`hasMouseTracking`
`hasTabletTracking`
`header`
`height`
`heightForWidth`
`heightMM`
`hide`
`hideColumn`
`hideEvent`
`horizontalOffset`
`horizontalScrollBar`
`horizontalScrollBarPolicy`
`horizontalScrollMode`
`horizontalScrollbarAction`
`horizontalScrollbarValueChanged`
`iconSize`
`indentation`
`indexAbove`
`indexAt`
`indexBelow`
`indexRowSizeHint`
`indexWidget`
`inherits`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`inputMethodHints`
`inputMethodQuery`
`insertAction`
`insertActions`
`installEventFilter`
`isActiveWindow`
`isAncestorOf`
`isAnimated`
`isColumnHidden`
`isEnabled`
`isEnabledTo`
`isExpanded`
`isFirstColumnSpanned`
`isFullScreen`
`isHeaderHidden`
`isHidden`
`isIndexHidden`
`isLeftToRight`
`isMaximized`
`isMinimized`
`isModal`
`isRightToLeft`
`isRowHidden`
`isSignalConnected`
`isSortingEnabled`
`isVisible`
`isVisibleTo`
`isWidgetType`
`isWindow`
`isWindowModified`
`isWindowType`
`itemDelegate`	itemDelegate(self, QModelIndex) -> QAbstractItemDelegate
`itemDelegateForColumn`
`itemDelegateForRow`
`itemsExpandable`
`keyPressEvent`
`keyReleaseEvent`
`keyboardGrabber`
`keyboardSearch`
`killTimer`
`layerForIndex`
`layerTreeModel`	Get access to the model casted to `QgsLayerTreeModel`
`layout`
`layoutDirection`
`leaveEvent`
`lineWidth`
`locale`
`logicalDpiX`
`logicalDpiY`
`lower`
`mapFrom`
`mapFromGlobal`
`mapFromParent`
`mapTo`
`mapToGlobal`
`mapToParent`
`mask`
`maximumHeight`
`maximumSize`
`maximumViewportSize`
`maximumWidth`
`menuProvider`	Return pointer to the context menu provider.
`metaObject`
`metric`
`midLineWidth`
`minimumHeight`
`minimumSize`
`minimumSizeHint`
`minimumWidth`
`model`
`modelRowsInserted`
`modelRowsRemoved`
`mouseDoubleClickEvent`
`mouseGrabber`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`move`	move(self, int, int)
`moveCursor`
`moveEvent`
`moveToThread`
`nativeEvent`
`nativeParentWidget`
`nextInFocusChain`
`normalGeometry`
`objectName`
`onCurrentChanged`
`onExpandedChanged`
`onModelReset`
`openPersistentEditor`
`overrideWindowFlags`
`overrideWindowState`
`paintEngine`
`paintEvent`
`paintingActive`
`palette`
`parent`
`parentWidget`
`physicalDpiX`
`physicalDpiY`
`pos`
`previousInFocusChain`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`raise_`
`receivers`
`rect`
`reexpand`
`refreshLayerSymbology`	Force refresh of layer symbology.
`releaseKeyboard`
`releaseMouse`
`releaseShortcut`
`removeAction`
`removeEventFilter`
`render`	render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground\|QWidget.DrawChildren))
`repaint`	repaint(self, int, int, int, int)
`reset`
`resetHorizontalScrollMode`
`resetIndentation`
`resetVerticalScrollMode`
`resize`	resize(self, int, int)
`resizeColumnToContents`
`resizeEvent`
`restoreGeometry`
`rootIndex`
`rootIsDecorated`
`rowHeight`
`rowsAboutToBeRemoved`
`rowsInserted`
`rowsRemoved`
`saveGeometry`
`scheduleDelayedItemsLayout`
`scroll`	scroll(self, int, int, QRect)
`scrollBarWidgets`
`scrollContentsBy`
`scrollDirtyRegion`
`scrollTo`
`scrollToBottom`
`scrollToTop`
`selectAll`
`selectedIndexes`
`selectedLayerNodes`	Return list of selected nodes filtered to just layer nodes
`selectedLayers`	Get list of selected layers
`selectedNodes`	Return list of selected nodes
`selectionBehavior`
`selectionChanged`
`selectionCommand`
`selectionMode`
`selectionModel`
`sender`
`senderSignalIndex`
`setAcceptDrops`
`setAccessibleDescription`
`setAccessibleName`
`setAllColumnsShowFocus`
`setAlternatingRowColors`
`setAnimated`
`setAttribute`
`setAutoExpandDelay`
`setAutoFillBackground`
`setAutoScroll`
`setAutoScrollMargin`
`setBackgroundRole`
`setBaseSize`	setBaseSize(self, QSize)
`setColumnHidden`
`setColumnWidth`
`setContentsMargins`	setContentsMargins(self, QMargins)
`setContextMenuPolicy`
`setCornerWidget`
`setCurrentIndex`
`setCurrentLayer`	Set currently selected layer.
`setCursor`
`setDefaultDropAction`
`setDirtyRegion`
`setDisabled`
`setDragDropMode`
`setDragDropOverwriteMode`
`setDragEnabled`
`setDropIndicatorShown`
`setEditTriggers`
`setEnabled`
`setExpanded`
`setExpandsOnDoubleClick`
`setFirstColumnSpanned`
`setFixedHeight`
`setFixedSize`	setFixedSize(self, int, int)
`setFixedWidth`
`setFocus`	setFocus(self, Qt.FocusReason)
`setFocusPolicy`
`setFocusProxy`
`setFont`
`setForegroundRole`
`setFrameRect`
`setFrameShadow`
`setFrameShape`
`setFrameStyle`
`setGeometry`	setGeometry(self, int, int, int, int)
`setGraphicsEffect`
`setHeader`
`setHeaderHidden`
`setHidden`
`setHorizontalScrollBar`
`setHorizontalScrollBarPolicy`
`setHorizontalScrollMode`
`setIconSize`
`setIndentation`
`setIndexWidget`
`setInputMethodHints`
`setItemDelegate`
`setItemDelegateForColumn`
`setItemDelegateForRow`
`setItemsExpandable`
`setLayout`
`setLayoutDirection`
`setLineWidth`
`setLocale`
`setMask`	setMask(self, QRegion)
`setMaximumHeight`
`setMaximumSize`	setMaximumSize(self, QSize)
`setMaximumWidth`
`setMenuProvider`	Set provider for context menu.
`setMidLineWidth`
`setMinimumHeight`
`setMinimumSize`	setMinimumSize(self, QSize)
`setMinimumWidth`
`setModel`	Overridden setModel() from base class.
`setMouseTracking`
`setObjectName`
`setPalette`
`setParent`	setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
`setProperty`
`setRootIndex`
`setRootIsDecorated`
`setRowHidden`
`setSelection`
`setSelectionBehavior`
`setSelectionMode`
`setSelectionModel`
`setShortcutAutoRepeat`
`setShortcutEnabled`
`setSizeAdjustPolicy`
`setSizeIncrement`	setSizeIncrement(self, QSize)
`setSizePolicy`	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
`setSortingEnabled`
`setState`
`setStatusTip`
`setStyle`
`setStyleSheet`
`setTabKeyNavigation`
`setTabOrder`
`setTabletTracking`
`setTextElideMode`
`setToolTip`
`setToolTipDuration`
`setTreePosition`
`setUniformRowHeights`
`setUpdatesEnabled`
`setVerticalScrollBar`
`setVerticalScrollBarPolicy`
`setVerticalScrollMode`
`setViewport`
`setViewportMargins`
`setVisible`
`setWhatsThis`
`setWindowFilePath`
`setWindowFlag`
`setWindowFlags`
`setWindowIcon`
`setWindowIconText`
`setWindowModality`
`setWindowModified`
`setWindowOpacity`
`setWindowRole`
`setWindowState`
`setWindowTitle`
`setWordWrap`
`setupViewport`
`sharedPainter`
`show`
`showColumn`
`showDropIndicator`
`showEvent`
`showFullScreen`
`showMaximized`
`showMinimized`
`showNormal`
`signalsBlocked`
`size`
`sizeAdjustPolicy`
`sizeHint`
`sizeHintForColumn`
`sizeHintForIndex`
`sizeHintForRow`
`sizeIncrement`
`sizePolicy`
`sortByColumn`
`stackUnder`
`startDrag`
`startTimer`
`state`
`statusTip`
`style`
`styleSheet`
`tabKeyNavigation`
`tabletEvent`
`testAttribute`
`textElideMode`
`thread`
`timerEvent`
`toolTip`
`toolTipDuration`
`tr`
`treePosition`
`underMouse`
`ungrabGesture`
`uniformRowHeights`
`unsetCursor`
`unsetLayoutDirection`
`unsetLocale`
`update`	update(self, QModelIndex)
`updateEditorData`
`updateEditorGeometries`
`updateExpandedStateFromNode`
`updateExpandedStateToNode`
`updateGeometries`
`updateGeometry`
`updateMicroFocus`
`updatesEnabled`
`verticalOffset`
`verticalScrollBar`
`verticalScrollBarPolicy`
`verticalScrollMode`
`verticalScrollbarAction`
`verticalScrollbarValueChanged`
`viewOptions`
`viewport`
`viewportEvent`
`viewportMargins`
`viewportSizeHint`
`visibleRegion`
`visualRect`
`visualRegionForSelection`
`whatsThis`
`wheelEvent`
`width`
`widthMM`
`winId`
`window`
`windowFilePath`
`windowFlags`
`windowHandle`
`windowIcon`
`windowIconText`
`windowModality`
`windowOpacity`
`windowRole`
`windowState`
`windowTitle`
`windowType`
`wordWrap`
`x`
`y`

Attributes

`AboveItem`
`AdjustIgnored`
`AdjustToContents`
`AdjustToContentsOnFirstShow`
`AllEditTriggers`
`AnimatingState`
`AnyKeyPressed`
`BelowItem`
`Box`
`CollapsingState`
`ContiguousSelection`
`CurrentChanged`
`DoubleClicked`
`DragDrop`
`DragOnly`
`DragSelectingState`
`DraggingState`
`DrawChildren`
`DrawWindowBackground`
`DropOnly`
`EditKeyPressed`
`EditingState`
`EnsureVisible`
`ExpandingState`
`ExtendedSelection`
`HLine`
`IgnoreMask`
`InternalMove`
`MoveDown`
`MoveEnd`
`MoveHome`
`MoveLeft`
`MoveNext`
`MovePageDown`
`MovePageUp`
`MovePrevious`
`MoveRight`
`MoveUp`
`MultiSelection`
`NoDragDrop`
`NoEditTriggers`
`NoFrame`
`NoSelection`
`NoState`
`OnItem`
`OnViewport`
`Panel`
`PdmDepth`
`PdmDevicePixelRatio`
`PdmDevicePixelRatioScaled`
`PdmDpiX`
`PdmDpiY`
`PdmHeight`
`PdmHeightMM`
`PdmNumColors`
`PdmPhysicalDpiX`
`PdmPhysicalDpiY`
`PdmWidth`
`PdmWidthMM`
`Plain`
`PositionAtBottom`
`PositionAtCenter`
`PositionAtTop`
`Raised`
`ScrollPerItem`
`ScrollPerPixel`
`SelectColumns`
`SelectItems`
`SelectRows`
`SelectedClicked`
`Shadow_Mask`
`Shape_Mask`
`SingleSelection`
`StyledPanel`
`Sunken`
`VLine`
`WinPanel`
`activated`	activated(self, QModelIndex) [signal]
`clicked`	clicked(self, QModelIndex) [signal]
`collapsed`	collapsed(self, QModelIndex) [signal]
`currentLayerChanged`	Emitted when a current layer is changed [signal]
`customContextMenuRequested`	customContextMenuRequested(self, QPoint) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`doubleClicked`	doubleClicked(self, QModelIndex) [signal]
`entered`	entered(self, QModelIndex) [signal]
`expanded`	expanded(self, QModelIndex) [signal]
`iconSizeChanged`	iconSizeChanged(self, QSize) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`pressed`	pressed(self, QModelIndex) [signal]
`staticMetaObject`
`viewportEntered`	viewportEntered(self) [signal]
`windowIconChanged`	windowIconChanged(self, QIcon) [signal]
`windowIconTextChanged`	windowIconTextChanged(self, str) [signal]
`windowTitleChanged`	windowTitleChanged(self, str) [signal]

actionEvent()¶

changeEvent()¶

childEvent()¶

closeEditor()¶

closeEvent()¶

collapseAllNodes(self)¶: Enhancement of QTreeView.collapseAll() that also records expanded state in layer tree nodes

New in version 2.18.

columnCountChanged()¶

columnMoved()¶

columnResized()¶

commitData()¶

connectNotify()¶

contextMenuEvent(self, event: QContextMenuEvent)¶

create()¶

currentChanged()¶

currentGroupNode(self) → QgsLayerTreeGroup¶: Get current group node. If a layer is current node, the function will return parent group. May be null.

currentLayer(self) → QgsMapLayer¶: Get currently selected layer. May be null

currentLayerChanged¶: Emitted when a current layer is changed [signal]

currentLegendNode(self) → QgsLayerTreeModelLegendNode¶: Get current legend node. May be null if current node is not a legend node.

New in version 2.14.

currentNode(self) → QgsLayerTreeNode¶: Get current node. May be null

customEvent()¶

defaultActions(self) → QgsLayerTreeViewDefaultActions¶: Get access to the default actions that may be used with the tree view

destroy()¶

dirtyRegionOffset()¶

disconnectNotify()¶

dragEnterEvent()¶

dragLeaveEvent()¶

dragMoveEvent()¶

drawBranches()¶

drawFrame()¶

drawRow()¶

drawTree()¶

dropEvent(self, event: QDropEvent)¶

dropIndicatorPosition()¶

edit()¶

editorDestroyed()¶

enterEvent()¶

event()¶

eventFilter()¶

executeDelayedItemsLayout()¶

expandAllNodes(self)¶: Enhancement of QTreeView.expandAll() that also records expanded state in layer tree nodes

New in version 2.18.

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

hideEvent()¶

horizontalOffset()¶

horizontalScrollbarAction()¶

horizontalScrollbarValueChanged()¶

indexRowSizeHint()¶

initPainter()¶

initStyleOption()¶

inputMethodEvent()¶

isIndexHidden()¶

isSignalConnected()¶

keyPressEvent(self, event: QKeyEvent)¶

keyReleaseEvent()¶

layerForIndex(self, index: QModelIndex) → QgsMapLayer¶

layerTreeModel(self) → QgsLayerTreeModel¶: Get access to the model casted to QgsLayerTreeModel

leaveEvent()¶

menuProvider(self) → QgsLayerTreeViewMenuProvider¶: Return pointer to the context menu provider. May be null

metric()¶

modelRowsInserted(self, index: QModelIndex, start: int, end: int)¶

modelRowsRemoved(self)¶

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent(self, event: QMouseEvent)¶

moveCursor()¶

moveEvent()¶

nativeEvent()¶

onCurrentChanged(self)¶

onExpandedChanged(self, node: QgsLayerTreeNode, expanded: bool)¶

onModelReset(self)¶

paintEvent()¶

receivers()¶

reexpand()¶

refreshLayerSymbology(self, layerId: str)¶: Force refresh of layer symbology. Normally not needed as the changes of layer’s renderer are monitored by the model

resizeEvent()¶

rowHeight()¶

rowsAboutToBeRemoved()¶

rowsInserted()¶

rowsRemoved()¶

scheduleDelayedItemsLayout()¶

scrollContentsBy()¶

scrollDirtyRegion()¶

selectedIndexes()¶

selectedLayerNodes(self) → List[QgsLayerTreeLayer]¶: Return list of selected nodes filtered to just layer nodes

selectedLayers(self) → List[QgsMapLayer]¶: Get list of selected layers

selectedNodes(self, skipInternal: bool = False) → List[QgsLayerTreeNode]¶

Return list of selected nodes

Parameters:	skipInternal – If true, will ignore nodes which have an ancestor in the selection

selectionChanged()¶

selectionCommand()¶

sender()¶

senderSignalIndex()¶

setCurrentLayer(self, layer: QgsMapLayer)¶: Set currently selected layer. Null pointer will deselect any layer.

setDirtyRegion()¶

setMenuProvider(self, menuProvider: QgsLayerTreeViewMenuProvider)¶: Set provider for context menu. Takes ownership of the instance

setModel(self, model: QAbstractItemModel)¶: Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model.

setSelection()¶

setState()¶

setViewportMargins()¶

sharedPainter()¶

showEvent()¶

sizeHintForColumn()¶

startDrag()¶

state()¶

tabletEvent()¶

timerEvent()¶

updateEditorData()¶

updateEditorGeometries()¶

updateExpandedStateFromNode(self, node: QgsLayerTreeNode)¶

updateExpandedStateToNode(self, index: QModelIndex)¶

updateGeometries()¶

updateMicroFocus()¶

verticalOffset()¶

verticalScrollbarAction()¶

verticalScrollbarValueChanged()¶

viewOptions()¶

viewportEvent()¶

viewportMargins()¶

viewportSizeHint()¶

visualRegionForSelection()¶

wheelEvent()¶