Class: QgsLayerTreeView

Extends QTreeView and provides 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

QgsLayerTreeView

Class Hierarchy

Base classes

QgsLayerTreeViewBase	Base class for QTreeView widgets which display a layer tree.
QTreeView
QAbstractItemView
QAbstractScrollArea
QFrame
QWidget
QObject
QPaintDevice

Methods

addIndicator	Adds an indicator to the given layer tree node.
hideValidLayers	Returns if valid layers should be hidden (i.e. only invalid layers are shown).
indicators	Returns list of indicators associated with a particular layer tree node.
layerMarkWidth	Returns width of contextual menu mark, at right of layer node items.
menuProvider	Returns pointer to the context menu provider.
modelRowsInserted
modelRowsRemoved
onCurrentChanged
proxyModel	Returns the proxy model used by the view.
refreshLayerSymbology	Force refresh of layer symbology.
removeIndicator	Removes a previously added indicator to a layer tree node.
setHideValidLayers	Sets whether valid layers should be hidden (i.e. only invalid layers are shown).
setLayerMarkWidth	Set width of contextual menu mark, at right of layer node items.
setLayerVisible	Convenience methods which sets the visible state of the specified map layer.
setMenuProvider	Sets provider for context menu.
setMessageBar	Set the message bar to display messages from the layer tree
setShowPrivateLayers	Set the show private layers to showPrivate
showPrivateLayers	Returns the show private layers status

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsLayerTreeView. See the FAQ for more details.

setModel

Overridden setModel() from base class.

Signals

contextMenuAboutToShow	Emitted when the context menu is about to show.
currentLayerChanged	Emitted when a current layer is changed
datasetsDropped	Emitted when datasets are dropped onto the layer tree view

class qgis.gui.QgsLayerTreeView

Bases: QgsLayerTreeViewBase

__init__(parent: QWidget | None = None)

Constructor for QgsLayerTreeView

Parameters:

parent (Optional[QWidget] = None)

addIndicator(self, node: QgsLayerTreeNode | None, indicator: QgsLayerTreeViewIndicator | None)

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

removeIndicator()

See also

indicators()

Added in version 3.2.

Parameters:

• node (Optional[QgsLayerTreeNode])

• indicator (Optional[QgsLayerTreeViewIndicator])

signal contextMenuAboutToShow(menu: QMenu)

Emitted when the context menu is about to show.

Allows customization of the menu.

Added in version 3.32.

Parameters:

menu (QMenu)

signal currentLayerChanged(layer: QgsMapLayer)

Emitted when a current layer is changed

Parameters:

layer (QgsMapLayer)

signal datasetsDropped(event: QDropEvent)

Emitted when datasets are dropped onto the layer tree view

Parameters:

event (QDropEvent)

hideValidLayers(self) → bool

Returns if valid layers should be hidden (i.e. only invalid layers are shown).

See also

setHideValidLayers()

Added in version 3.38.

Return type:

bool

indicators(self, node: QgsLayerTreeNode | None) → List[QgsLayerTreeViewIndicator]

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

See also

addIndicator()

See also

removeIndicator()

Added in version 3.2.

Parameters:

node (Optional[QgsLayerTreeNode])

Return type:

List[QgsLayerTreeViewIndicator]

layerMarkWidth(self) → int

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

See also

setLayerMarkWidth()

Added in version 3.8.

Return type:

int

menuProvider(self) → QgsLayerTreeViewMenuProvider | None

Returns pointer to the context menu provider. May be None

Return type:

Optional[QgsLayerTreeViewMenuProvider]

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

Parameters:

• index (QModelIndex)

• start (int)

• end (int)

modelRowsRemoved(self)

onCurrentChanged(self)

proxyModel(self) → QgsLayerTreeProxyModel | None

Returns the proxy model used by the view.

This can be used to set filters controlling which layers are shown in the view.

Added in version 3.18.

Return type:

Optional[QgsLayerTreeProxyModel]

refreshLayerSymbology(self, layerId: str | None)

Force refresh of layer symbology. Normally not needed as the changes of layer’s renderer are monitored by the model

Parameters:

layerId (Optional[str])

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

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

See also

addIndicator()

See also

indicators()

Added in version 3.2.

Parameters:

• node (Optional[QgsLayerTreeNode])

• indicator (Optional[QgsLayerTreeViewIndicator])

setHideValidLayers(self, hideValid: bool)

Sets whether valid layers should be hidden (i.e. only invalid layers are shown).

See also

setHideValidLayers()

Added in version 3.38.

Parameters:

hideValid (bool)

setLayerMarkWidth(self, width: int)

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

See also

layerMarkWidth()

Added in version 3.8.

Parameters:

width (int)

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

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

See also

QgsLayerTreeNode.setItemVisibilityChecked()

Added in version 3.10.

Parameters:

• layer (Optional[QgsMapLayer])

• visible (bool)

setMenuProvider(self, menuProvider: QgsLayerTreeViewMenuProvider | None)

Sets provider for context menu. Takes ownership of the instance

Parameters:

menuProvider (Optional[QgsLayerTreeViewMenuProvider])

setMessageBar(self, messageBar: QgsMessageBar | None)

Set the message bar to display messages from the layer tree

Added in version 3.14.

Parameters:

messageBar (Optional[QgsMessageBar])

virtual setModel(self, model: QAbstractItemModel | None)

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

Note

This method automatically creates a QgsLayerTreeProxyModel to use as a proxy.

Parameters:

model (Optional[QAbstractItemModel])

virtual setModel(self, model: QgsLayerTreeModel | None, proxyModel: QgsLayerTreeProxyModel | None)

Sets the model and proxyModel for the view.

Use this method when a custom proxy model is required.

Added in version 4.0.

Parameters:

• model (Optional[QgsLayerTreeModel])

• proxyModel (Optional[QgsLayerTreeProxyModel])

setShowPrivateLayers(self, showPrivate: bool)

Set the show private layers to showPrivate

Added in version 3.18.

Parameters:

showPrivate (bool)

showPrivateLayers(self) → bool

Returns the show private layers status

Added in version 3.18.

Return type:

bool