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

#include <qgslayertreeview.h>

Inheritance diagram for QgsLayerTreeView:

[legend]

Public Slots
void	collapseAllNodes ()
	Enhancement of QTreeView::collapseAll() that also records expanded state in layer tree nodes. More...

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

void	refreshLayerSymbology (const QString &layerId)
	Force refresh of layer symbology. Normally not needed as the changes of layer's renderer are monitored by the model. More...

void	setLayerMarkWidth (int width)
	Set width of contextual menu mark, at right of layer node items. More...

void	setMessageBar (QgsMessageBar *messageBar)
	Set the message bar to display messages from the layer tree. More...

void	setShowPrivateLayers (bool showPrivate)
	Set the show private layers to showPrivate. More...

bool	showPrivateLayers ()
	Returns the show private layers status. More...

Signals
void	currentLayerChanged (QgsMapLayer *layer)
	Emitted when a current layer is changed. More...

Public Member Functions
	QgsLayerTreeView (QWidget *parent=nullptr)
	Constructor for QgsLayerTreeView. More...

	~QgsLayerTreeView () override

void	addIndicator (QgsLayerTreeNode node, QgsLayerTreeViewIndicator indicator)
	Adds an indicator to the given layer tree node. More...

QgsLayerTreeGroup *	currentGroupNode () const
	Gets current group node. If a layer is current node, the function will return parent group. May be `nullptr`. More...

QgsMapLayer *	currentLayer () const
	Returns the currently selected layer, or `nullptr` if no layers is selected. More...

QgsLayerTreeModelLegendNode *	currentLegendNode () const
	Gets current legend node. More...

QgsLayerTreeNode *	currentNode () const
	Gets current node. May be `nullptr`. More...

QgsLayerTreeViewDefaultActions *	defaultActions ()
	Gets access to the default actions that may be used with the tree view. More...

QgsLayerTreeModelLegendNode *	index2legendNode (const QModelIndex &index) const
	Returns legend node for given proxy model tree index. More...

QgsLayerTreeNode *	index2node (const QModelIndex &index) const
	Returns layer tree node for given proxy model tree index. More...

QList< QgsLayerTreeViewIndicator * >	indicators (QgsLayerTreeNode *node) const
	Returns list of indicators associated with a particular layer tree node. More...

int	layerMarkWidth () const
	Returns width of contextual menu mark, at right of layer node items. More...

QgsLayerTreeModel *	layerTreeModel () const
	Gets access to the model casted to QgsLayerTreeModel. More...

QModelIndex	legendNode2index (QgsLayerTreeModelLegendNode *legendNode)
	Returns proxy model index for a given legend node. More...

QModelIndex	legendNode2sourceIndex (QgsLayerTreeModelLegendNode *legendNode)
	Returns index for a given legend node. More...

QgsLayerTreeViewMenuProvider *	menuProvider () const
	Returns pointer to the context menu provider. May be `nullptr`. More...

QModelIndex	node2index (QgsLayerTreeNode *node) const
	Returns proxy model index for a given node. More...

QModelIndex	node2sourceIndex (QgsLayerTreeNode *node) const
	Returns source model index for a given node. More...

QgsLayerTreeProxyModel *	proxyModel () const
	Returns the proxy model used by the view. More...

void	removeIndicator (QgsLayerTreeNode node, QgsLayerTreeViewIndicator indicator)
	Removes a previously added indicator to a layer tree node. More...

QList< QgsLayerTreeLayer * >	selectedLayerNodes () const
	Returns list of selected nodes filtered to just layer nodes. More...

QList< QgsMapLayer * >	selectedLayers () const
	Gets list of selected layers. More...

QList< QgsMapLayer * >	selectedLayersRecursive () const
	Gets list of selected layers, including those that are not directly selected, but their ancestor groups is selected. More...

QList< QgsLayerTreeNode * >	selectedNodes (bool skipInternal=false) const
	Returns list of selected nodes. More...

void	setCurrentLayer (QgsMapLayer *layer)
	Sets the currently selected layer. More...

void	setLayerVisible (QgsMapLayer *layer, bool visible)
	Convenience methods which sets the visible state of the specified map layer. More...

void	setMenuProvider (QgsLayerTreeViewMenuProvider *menuProvider)
	Sets provider for context menu. Takes ownership of the instance. More...

void	setModel (QAbstractItemModel *model) override
	Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model. More...

Protected Slots
void	modelRowsInserted (const QModelIndex &index, int start, int end)

void	modelRowsRemoved ()

void	onCurrentChanged ()

void	onExpandedChanged (QgsLayerTreeNode *node, bool expanded)

void	onModelReset ()

void	updateExpandedStateToNode (const QModelIndex &index)

Protected Member Functions
void	contextMenuEvent (QContextMenuEvent *event) override

void	dropEvent (QDropEvent *event) override

void	keyPressEvent (QKeyEvent *event) override

QgsMapLayer *	layerForIndex (const QModelIndex &index) const

void	mouseReleaseEvent (QMouseEvent *event) override

void	resizeEvent (QResizeEvent *event) override

void	updateExpandedStateFromNode (QgsLayerTreeNode *node)

Protected Attributes
QString	mCurrentLayerID
	Keeps track of current layer ID (to check when to emit signal about change of current layer) More...

QgsLayerTreeViewDefaultActions *	mDefaultActions = nullptr
	helper class with default actions. Lazily initialized. More...

QHash< QgsLayerTreeNode , QList< QgsLayerTreeViewIndicator > >	mIndicators
	Storage of indicators used with the tree view. More...

QPoint	mLastReleaseMousePos
	Used by the item delegate for identification of which indicator has been clicked. More...

int	mLayerMarkWidth
	Width of contextual menu mark for layer nodes. More...

QgsLayerTreeViewMenuProvider *	mMenuProvider = nullptr
	Context menu provider. Owned by the view. More...

Friends
class	QgsLayerTreeViewItemDelegate

Detailed Description

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

Since: QGIS 2.4

Definition at line 103 of file qgslayertreeview.h.

Constructor & Destructor Documentation

◆ QgsLayerTreeView()

QgsLayerTreeView::QgsLayerTreeView ( QWidget * parent = nullptr )

explicit

Constructor for QgsLayerTreeView.

Definition at line 43 of file qgslayertreeview.cpp.

◆ ~QgsLayerTreeView()

QgsLayerTreeView::~QgsLayerTreeView ( )

override

Definition at line 77 of file qgslayertreeview.cpp.

Member Function Documentation

◆ addIndicator()

void QgsLayerTreeView::addIndicator	(	QgsLayerTreeNode *	node,
		QgsLayerTreeViewIndicator *	indicator
	)

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; indicators

Since: QGIS 3.2

Definition at line 462 of file qgslayertreeview.cpp.

◆ collapseAllNodes

void QgsLayerTreeView::collapseAllNodes ( )

slot

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

Since: QGIS 2.18

Definition at line 541 of file qgslayertreeview.cpp.

◆ contextMenuEvent()

void QgsLayerTreeView::contextMenuEvent ( QContextMenuEvent * event )

overrideprotected

Definition at line 171 of file qgslayertreeview.cpp.

◆ currentGroupNode()

QgsLayerTreeGroup * QgsLayerTreeView::currentGroupNode ( ) const

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

Definition at line 387 of file qgslayertreeview.cpp.

◆ currentLayer()

QgsMapLayer * QgsLayerTreeView::currentLayer ( ) const

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

See also: setCurrentLayer()

Definition at line 141 of file qgslayertreeview.cpp.

◆ currentLayerChanged

void QgsLayerTreeView::currentLayerChanged ( QgsMapLayer * layer )

signal

Emitted when a current layer is changed.

◆ currentLegendNode()

QgsLayerTreeModelLegendNode * QgsLayerTreeView::currentLegendNode ( ) const

Gets current legend node.

May be nullptr if current node is not a legend node.

Since: QGIS 2.14

Definition at line 409 of file qgslayertreeview.cpp.

◆ currentNode()

QgsLayerTreeNode * QgsLayerTreeView::currentNode ( ) const

Gets current node. May be nullptr.

Definition at line 382 of file qgslayertreeview.cpp.

◆ defaultActions()

QgsLayerTreeViewDefaultActions * QgsLayerTreeView::defaultActions ( )

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

Definition at line 128 of file qgslayertreeview.cpp.

◆ dropEvent()

void QgsLayerTreeView::dropEvent ( QDropEvent * event )

overrideprotected

Definition at line 619 of file qgslayertreeview.cpp.

◆ expandAllNodes

void QgsLayerTreeView::expandAllNodes ( )

slot

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

Since: QGIS 2.18

Definition at line 534 of file qgslayertreeview.cpp.

◆ index2legendNode()

QgsLayerTreeModelLegendNode * QgsLayerTreeView::index2legendNode ( const QModelIndex & index ) const

Returns legend node for given proxy model tree index.

Returns nullptr for invalid index

Unlike QgsLayerTreeModel::index2legendNode(), calling this method correctly accounts for mapping the view indexes through the view's proxy model to the source model.

Since: QGIS 3.18

Definition at line 711 of file qgslayertreeview.cpp.

◆ index2node()

QgsLayerTreeNode * QgsLayerTreeView::index2node ( const QModelIndex & index ) const

Returns layer tree node for given proxy model tree index.

Returns root node for invalid index. Returns nullptr if index does not refer to a layer tree node (e.g. it is a legend node)

Unlike QgsLayerTreeModel::index2Node(), calling this method correctly accounts for mapping the view indexes through the view's proxy model to the source model.

Since: QGIS 3.18

Definition at line 696 of file qgslayertreeview.cpp.

◆ indicators()

QList< QgsLayerTreeViewIndicator * > QgsLayerTreeView::indicators ( QgsLayerTreeNode * node ) const

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

See also: addIndicator; removeIndicator

Since: QGIS 3.2

Definition at line 481 of file qgslayertreeview.cpp.

◆ keyPressEvent()

void QgsLayerTreeView::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 591 of file qgslayertreeview.cpp.

◆ layerForIndex()

QgsMapLayer * QgsLayerTreeView::layerForIndex ( const QModelIndex & index ) const

protected

Definition at line 360 of file qgslayertreeview.cpp.

◆ layerMarkWidth()

int QgsLayerTreeView::layerMarkWidth ( ) const

inline

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

See also: setLayerMarkWidth

Since: QGIS 3.8

Definition at line 292 of file qgslayertreeview.h.

◆ layerTreeModel()

QgsLayerTreeModel * QgsLayerTreeView::layerTreeModel ( ) const

Gets access to the model casted to QgsLayerTreeModel.

Definition at line 123 of file qgslayertreeview.cpp.

◆ legendNode2index()

QModelIndex QgsLayerTreeView::legendNode2index ( QgsLayerTreeModelLegendNode * legendNode )

Returns proxy model index for a given legend node.

If the legend node does not belong to the layer tree, the result is undefined. If the legend node is belongs to the tree but it is filtered out, invalid model index is returned.

Unlike QgsLayerTreeModel::legendNode2index(), calling this method correctly accounts for mapping the view indexes through the view's proxy model to the source model.

Since: QGIS 3.18

Definition at line 716 of file qgslayertreeview.cpp.

◆ legendNode2sourceIndex()

QModelIndex QgsLayerTreeView::legendNode2sourceIndex ( QgsLayerTreeModelLegendNode * legendNode )

Returns index for a given legend node.

If the legend node does not belong to the layer tree, the result is undefined. If the legend node is belongs to the tree but it is filtered out, invalid model index is returned.

Since: QGIS 3.18

Definition at line 721 of file qgslayertreeview.cpp.

◆ menuProvider()

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::menuProvider ( ) const

inline

Returns pointer to the context menu provider. May be nullptr.

Definition at line 203 of file qgslayertreeview.h.

◆ modelRowsInserted

void QgsLayerTreeView::modelRowsInserted	(	const QModelIndex &	index,
		int	start,
		int	end
	)

protectedslot

Definition at line 187 of file qgslayertreeview.cpp.

◆ modelRowsRemoved

void QgsLayerTreeView::modelRowsRemoved ( )

protectedslot

Definition at line 258 of file qgslayertreeview.cpp.

◆ mouseReleaseEvent()

void QgsLayerTreeView::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Definition at line 576 of file qgslayertreeview.cpp.

◆ node2index()

QModelIndex QgsLayerTreeView::node2index ( QgsLayerTreeNode * node ) const

Returns proxy model index for a given node.

If the node does not belong to the layer tree, the result is undefined

Unlike QgsLayerTreeModel::node2index(), calling this method correctly accounts for mapping the view indexes through the view's proxy model to the source model.

Since: QGIS 3.18

Definition at line 701 of file qgslayertreeview.cpp.

◆ node2sourceIndex()

QModelIndex QgsLayerTreeView::node2sourceIndex ( QgsLayerTreeNode * node ) const

Returns source model index for a given node.

If the node does not belong to the layer tree, the result is undefined

Since: QGIS 3.18

Definition at line 706 of file qgslayertreeview.cpp.

◆ onCurrentChanged

void QgsLayerTreeView::onCurrentChanged ( )

protectedslot

Definition at line 289 of file qgslayertreeview.cpp.

◆ onExpandedChanged

void QgsLayerTreeView::onExpandedChanged	(	QgsLayerTreeNode *	node,
		bool	expanded
	)

protectedslot

Definition at line 321 of file qgslayertreeview.cpp.

◆ onModelReset

void QgsLayerTreeView::onModelReset ( )

protectedslot

Definition at line 344 of file qgslayertreeview.cpp.

◆ proxyModel()

QgsLayerTreeProxyModel * QgsLayerTreeView::proxyModel ( ) const

Returns the proxy model used by the view.

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

Since: QGIS 3.18

Definition at line 691 of file qgslayertreeview.cpp.

◆ refreshLayerSymbology

void QgsLayerTreeView::refreshLayerSymbology ( const QString & layerId )

slot

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

Definition at line 493 of file qgslayertreeview.cpp.

◆ removeIndicator()

void QgsLayerTreeView::removeIndicator	(	QgsLayerTreeNode *	node,
		QgsLayerTreeViewIndicator *	indicator
	)

Removes a previously added indicator to a layer tree node.

Does not delete the indicator.

See also: addIndicator; indicators

Since: QGIS 3.2

Definition at line 475 of file qgslayertreeview.cpp.

◆ resizeEvent()

void QgsLayerTreeView::resizeEvent ( QResizeEvent * event )

overrideprotected

Definition at line 628 of file qgslayertreeview.cpp.

◆ selectedLayerNodes()

QList< QgsLayerTreeLayer * > QgsLayerTreeView::selectedLayerNodes ( ) const

Returns list of selected nodes filtered to just layer nodes.

Definition at line 425 of file qgslayertreeview.cpp.

◆ selectedLayers()

QList< QgsMapLayer * > QgsLayerTreeView::selectedLayers ( ) const

Gets list of selected layers.

Definition at line 437 of file qgslayertreeview.cpp.

◆ selectedLayersRecursive()

QList< QgsMapLayer * > QgsLayerTreeView::selectedLayersRecursive ( ) const

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.

Since: QGIS 3.4

Definition at line 449 of file qgslayertreeview.cpp.

◆ selectedNodes()

QList< QgsLayerTreeNode * > QgsLayerTreeView::selectedNodes ( bool skipInternal = false ) const

Returns list of selected nodes.

Parameters

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

Definition at line 414 of file qgslayertreeview.cpp.

◆ setCurrentLayer()

void QgsLayerTreeView::setCurrentLayer ( QgsMapLayer * layer )

Sets the currently selected layer.

If layer is nullptr then all layers will be deselected.

See also: currentLayer()

Definition at line 146 of file qgslayertreeview.cpp.

◆ setLayerMarkWidth

void QgsLayerTreeView::setLayerMarkWidth ( int width )

inlineslot

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

See also: layerMarkWidth

Since: QGIS 3.8

Definition at line 329 of file qgslayertreeview.h.

◆ setLayerVisible()

void QgsLayerTreeView::setLayerVisible	(	QgsMapLayer *	layer,
		bool	visible
	)

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

See also: QgsLayerTreeNode::setItemVisibilityChecked()

Since: QGIS 3.10

Definition at line 161 of file qgslayertreeview.cpp.

◆ setMenuProvider()

void QgsLayerTreeView::setMenuProvider ( QgsLayerTreeViewMenuProvider * menuProvider )

Sets provider for context menu. Takes ownership of the instance.

Definition at line 135 of file qgslayertreeview.cpp.

◆ setMessageBar

void QgsLayerTreeView::setMessageBar ( QgsMessageBar * messageBar )

slot

Set the message bar to display messages from the layer tree.

Since: QGIS 3.14

Definition at line 548 of file qgslayertreeview.cpp.

◆ setModel()

void QgsLayerTreeView::setModel ( QAbstractItemModel * model )

override

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

Definition at line 82 of file qgslayertreeview.cpp.

◆ setShowPrivateLayers

void QgsLayerTreeView::setShowPrivateLayers ( bool showPrivate )

slot

Set the show private layers to showPrivate.

Since: QGIS 3.18

Definition at line 565 of file qgslayertreeview.cpp.

◆ showPrivateLayers

bool QgsLayerTreeView::showPrivateLayers ( )

slot

Returns the show private layers status.

Since: QGIS 3.18

Definition at line 571 of file qgslayertreeview.cpp.

◆ updateExpandedStateFromNode()

void QgsLayerTreeView::updateExpandedStateFromNode ( QgsLayerTreeNode * node )

protected

Definition at line 350 of file qgslayertreeview.cpp.

◆ updateExpandedStateToNode

void QgsLayerTreeView::updateExpandedStateToNode ( const QModelIndex & index )

protectedslot

Definition at line 264 of file qgslayertreeview.cpp.

Friends And Related Function Documentation

◆ QgsLayerTreeViewItemDelegate

friend class QgsLayerTreeViewItemDelegate

friend

Definition at line 411 of file qgslayertreeview.h.

Member Data Documentation

◆ mCurrentLayerID

QString QgsLayerTreeView::mCurrentLayerID

protected

Keeps track of current layer ID (to check when to emit signal about change of current layer)

Definition at line 391 of file qgslayertreeview.h.

◆ mDefaultActions

QgsLayerTreeViewDefaultActions* QgsLayerTreeView::mDefaultActions = nullptr

protected

helper class with default actions. Lazily initialized.

Definition at line 387 of file qgslayertreeview.h.

◆ mIndicators

QHash< QgsLayerTreeNode *, QList<QgsLayerTreeViewIndicator *> > QgsLayerTreeView::mIndicators

protected

Storage of indicators used with the tree view.

Definition at line 393 of file qgslayertreeview.h.

◆ mLastReleaseMousePos

QPoint QgsLayerTreeView::mLastReleaseMousePos

protected

Used by the item delegate for identification of which indicator has been clicked.

Definition at line 395 of file qgslayertreeview.h.

◆ mLayerMarkWidth

int QgsLayerTreeView::mLayerMarkWidth

protected

Width of contextual menu mark for layer nodes.

Definition at line 398 of file qgslayertreeview.h.

◆ mMenuProvider

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::mMenuProvider = nullptr

protected

Context menu provider. Owned by the view.

Definition at line 389 of file qgslayertreeview.h.

The documentation for this class was generated from the following files:

/build/qgis-3.20.0+99unstable/src/gui/layertree/qgslayertreeview.h
/build/qgis-3.20.0+99unstable/src/gui/layertree/qgslayertreeview.cpp

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QgsLayerTreeView()

◆ ~QgsLayerTreeView()

Member Function Documentation

◆ addIndicator()

◆ collapseAllNodes

◆ contextMenuEvent()

◆ currentGroupNode()

◆ currentLayer()

◆ currentLayerChanged

◆ currentLegendNode()

◆ currentNode()

◆ defaultActions()

◆ dropEvent()

◆ expandAllNodes

◆ index2legendNode()

◆ index2node()

◆ indicators()

◆ keyPressEvent()

◆ layerForIndex()

◆ layerMarkWidth()

◆ layerTreeModel()

◆ legendNode2index()

◆ legendNode2sourceIndex()

◆ menuProvider()

◆ modelRowsInserted

◆ modelRowsRemoved

◆ mouseReleaseEvent()

◆ node2index()

◆ node2sourceIndex()

◆ onCurrentChanged

◆ onExpandedChanged

◆ onModelReset

◆ proxyModel()

◆ refreshLayerSymbology

◆ removeIndicator()

◆ resizeEvent()

◆ selectedLayerNodes()

◆ selectedLayers()

◆ selectedLayersRecursive()

◆ selectedNodes()

◆ setCurrentLayer()

◆ setLayerMarkWidth

◆ setLayerVisible()

◆ setMenuProvider()

◆ setMessageBar

◆ setModel()

◆ setShowPrivateLayers

◆ showPrivateLayers

◆ updateExpandedStateFromNode()

◆ updateExpandedStateToNode

Friends And Related Function Documentation

◆ QgsLayerTreeViewItemDelegate

Member Data Documentation

◆ mCurrentLayerID

◆ mDefaultActions

◆ mIndicators

◆ mLastReleaseMousePos

◆ mLayerMarkWidth

◆ mMenuProvider