Class: QgsLayerTreeView

class qgis.gui.QgsLayerTreeView(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QTreeView

Constructor for QgsLayerTreeView

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.

New in version 2.4.

Parameters

parent

actionEvent()
addIndicator(self, node: QgsLayerTreeNode, indicator: QgsLayerTreeViewIndicator)

Adds an indicator to the given layer tree node. Indicators are icons shown next to layer/group names in the layer tree view. They can be used to show extra information with tree nodes and they allow user interaction.

Does not take ownership of the indicator. One indicator object may be used for multiple layer tree nodes.

See also

indicators()

New in version 3.2.

Parameters
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)
Parameters

event (QContextMenuEvent) –

create()
currentChanged()
currentGroupNode(self)QgsLayerTreeGroup

Gets current group node. If a layer is current node, the function will return parent group. May be None.

Return type

QgsLayerTreeGroup

currentLayer(self)QgsMapLayer

Returns the currently selected layer, or None if no layers is selected.

Return type

QgsMapLayer

currentLayerChanged

Emitted when a current layer is changed [signal]

Parameters

layer (QgsMapLayer) –

currentLegendNode(self)QgsLayerTreeModelLegendNode

Gets current legend node. May be None if current node is not a legend node.

New in version 2.14.

Return type

QgsLayerTreeModelLegendNode

currentNode(self)QgsLayerTreeNode

Gets current node. May be None

Return type

QgsLayerTreeNode

customEvent()
defaultActions(self)QgsLayerTreeViewDefaultActions

Gets access to the default actions that may be used with the tree view

Return type

QgsLayerTreeViewDefaultActions

destroy()
dirtyRegionOffset()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
drawBranches()
drawFrame()
drawRow()
drawTree()
dropEvent(self, event: QDropEvent)
Parameters

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()
indicators(self, node: QgsLayerTreeNode) → List[QgsLayerTreeViewIndicator]

Returns list of indicators associated with a particular layer tree node.

See also

addIndicator()

New in version 3.2.

Parameters

node (QgsLayerTreeNode) –

Return type

List[QgsLayerTreeViewIndicator]

initPainter()
initStyleOption()
inputMethodEvent()
isIndexHidden()
isSignalConnected()
keyPressEvent(self, event: QKeyEvent)
Parameters

event (QKeyEvent) –

keyReleaseEvent()
layerForIndex(self, index: QModelIndex)QgsMapLayer
Parameters

index (QModelIndex) –

Return type

QgsMapLayer

layerMarkWidth(self) → int

Returns width of contextual menu mark, at right of layer node items.

New in version 3.8.

Return type

int

layerTreeModel(self)QgsLayerTreeModel

Gets access to the model casted to QgsLayerTreeModel

Return type

QgsLayerTreeModel

leaveEvent()
menuProvider(self)QgsLayerTreeViewMenuProvider

Returns pointer to the context menu provider. May be None

Return type

QgsLayerTreeViewMenuProvider

metric()
modelRowsInserted(self, index: QModelIndex, start: int, end: int)
Parameters
  • index (QModelIndex) –

  • start (int) –

  • end (int) –

modelRowsRemoved(self)
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent(self, event: QMouseEvent)
Parameters

event (QMouseEvent) –

moveCursor()
moveEvent()
nativeEvent()
onCurrentChanged(self)
onExpandedChanged(self, node: QgsLayerTreeNode, expanded: bool)
Parameters
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

Parameters

layerId (str) –

removeIndicator(self, node: QgsLayerTreeNode, indicator: QgsLayerTreeViewIndicator)

Removes a previously added indicator to a layer tree node. Does not delete the indicator.

See also

addIndicator()

See also

indicators()

New in version 3.2.

Parameters
resizeEvent(self, event: QResizeEvent)
Parameters

event (QResizeEvent) –

rowHeight()
rowsAboutToBeRemoved()
rowsInserted()
rowsRemoved()
scheduleDelayedItemsLayout()
scrollContentsBy()
scrollDirtyRegion()
selectedIndexes()
selectedLayerNodes(self) → List[QgsLayerTreeLayer]

Returns list of selected nodes filtered to just layer nodes

Return type

List[QgsLayerTreeLayer]

selectedLayers(self) → List[QgsMapLayer]

Gets list of selected layers

Return type

List[QgsMapLayer]

selectedLayersRecursive(self) → List[QgsMapLayer]

Gets list of selected layers, including those that are not directly selected, but their ancestor groups is selected. If we have a group with two layers L1, L2 and just the group node is selected, this method returns L1 and L2, while selectedLayers() returns an empty list.

New in version 3.4.

Return type

List[QgsMapLayer]

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

Returns list of selected nodes

Parameters

skipInternal (bool = False) – If True, will ignore nodes which have an ancestor in the selection

Return type

List[QgsLayerTreeNode]

selectionChanged()
selectionCommand()
sender()
senderSignalIndex()
setCurrentLayer(self, layer: QgsMapLayer)

Sets the currently selected layer.

If layer is None then all layers will be deselected.

See also

currentLayer()

Parameters

layer (QgsMapLayer) –

setDirtyRegion()
setLayerMarkWidth(self, width: int)

Set width of contextual menu mark, at right of layer node items.

See also

layerMarkWidth()

New in version 3.8.

Parameters

width (int) –

setLayerVisible(self, layer: QgsMapLayer, visible: bool)

Convenience methods which sets the visible state of the specified map layer.

See also

QgsLayerTreeNode.setItemVisibilityChecked()

New in version 3.10.

Parameters
setMenuProvider(self, menuProvider: QgsLayerTreeViewMenuProvider)

Sets provider for context menu. Takes ownership of the instance

Parameters

menuProvider (QgsLayerTreeViewMenuProvider) –

setModel(self, model: QAbstractItemModel)

Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model.

Parameters

model (QAbstractItemModel) –

setSelection()
setState()
setViewportMargins()
sharedPainter()
showEvent()
sizeHintForColumn()
startDrag()
state()
tabletEvent()
timerEvent()
updateEditorData()
updateEditorGeometries()
updateExpandedStateFromNode(self, node: QgsLayerTreeNode)
Parameters

node (QgsLayerTreeNode) –

updateExpandedStateToNode(self, index: QModelIndex)
Parameters

index (QModelIndex) –

updateGeometries()
updateMicroFocus()
verticalOffset()
verticalScrollbarAction()
verticalScrollbarValueChanged()
viewOptions()
viewportEvent()
viewportMargins()
viewportSizeHint()
visualRegionForSelection()
wheelEvent()