QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Friends | List of all members
QgsLayerTreeView Class Reference

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

#include <qgslayertreeview.h>

Inheritance diagram for QgsLayerTreeView:
Inheritance graph
[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 setHideValidLayers (bool hideValid)
 Sets whether valid layers should be hidden (i.e. 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...
 

Signals

void contextMenuAboutToShow (QMenu *menu)
 Emitted when the context menu is about to show. More...
 
void currentLayerChanged (QgsMapLayer *layer)
 Emitted when a current layer is changed. More...
 
void datasetsDropped (QDropEvent *event)
 Emitted when datasets are dropped onto the layer tree view. 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...
 
QgsLayerTreeGroupcurrentGroupNode () const
 Gets current group node. If a layer is current node, the function will return parent group. May be nullptr. More...
 
QgsMapLayercurrentLayer () const
 Returns the currently selected layer, or nullptr if no layers is selected. More...
 
QgsLayerTreeModelLegendNodecurrentLegendNode () const
 Gets current legend node. More...
 
QgsLayerTreeNodecurrentNode () const
 Gets current node. May be nullptr. More...
 
QgsLayerTreeViewDefaultActionsdefaultActions ()
 Gets access to the default actions that may be used with the tree view. More...
 
bool hideValidLayers () const
 Returns if valid layers should be hidden (i.e. More...
 
QgsLayerTreeModelLegendNodeindex2legendNode (const QModelIndex &index) const
 Returns legend node for given proxy model tree index. More...
 
QgsLayerTreeNodeindex2node (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...
 
QgsLayerTreeModellayerTreeModel () 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...
 
QgsLayerTreeViewMenuProvidermenuProvider () 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...
 
QgsLayerTreeProxyModelproxyModel () 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 the list of selected nodes filtered to just layer nodes (QgsLayerTreeLayer). More...
 
QList< QgsMapLayer * > selectedLayers () const
 Returns the 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< QgsLayerTreeModelLegendNode * > selectedLegendNodes () const
 Returns the list of selected legend nodes. More...
 
QList< QgsLayerTreeNode * > selectedNodes (bool skipInternal=false) const
 Returns the list of selected layer tree 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...
 
bool showPrivateLayers () const
 Returns the show private layers status. 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 dragEnterEvent (QDragEnterEvent *event) override
 
void dragMoveEvent (QDragMoveEvent *event) override
 
void dropEvent (QDropEvent *event) override
 
void keyPressEvent (QKeyEvent *event) override
 
QgsMapLayerlayerForIndex (const QModelIndex &index) const
 
void mouseDoubleClickEvent (QMouseEvent *event) override
 
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...
 
QgsLayerTreeViewDefaultActionsmDefaultActions = 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...
 
QgsLayerTreeViewMenuProvidermMenuProvider = 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

Definition at line 119 of file qgslayertreeview.h.

Constructor & Destructor Documentation

◆ QgsLayerTreeView()

QgsLayerTreeView::QgsLayerTreeView ( QWidget *  parent = nullptr)
explicit

Constructor for QgsLayerTreeView.

Definition at line 44 of file qgslayertreeview.cpp.

◆ ~QgsLayerTreeView()

QgsLayerTreeView::~QgsLayerTreeView ( )
override

Definition at line 81 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 494 of file qgslayertreeview.cpp.

◆ collapseAllNodes

void QgsLayerTreeView::collapseAllNodes ( )
slot

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

Definition at line 575 of file qgslayertreeview.cpp.

◆ contextMenuAboutToShow

void QgsLayerTreeView::contextMenuAboutToShow ( QMenu *  menu)
signal

Emitted when the context menu is about to show.

Allows customization of the menu.

Since
QGIS 3.32

◆ contextMenuEvent()

void QgsLayerTreeView::contextMenuEvent ( QContextMenuEvent *  event)
overrideprotected

Definition at line 179 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 400 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 149 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.

Definition at line 422 of file qgslayertreeview.cpp.

◆ currentNode()

QgsLayerTreeNode * QgsLayerTreeView::currentNode ( ) const

Gets current node. May be nullptr.

Definition at line 395 of file qgslayertreeview.cpp.

◆ datasetsDropped

void QgsLayerTreeView::datasetsDropped ( QDropEvent *  event)
signal

Emitted when datasets are dropped onto the layer tree view.

◆ defaultActions()

QgsLayerTreeViewDefaultActions * QgsLayerTreeView::defaultActions ( )

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

Definition at line 136 of file qgslayertreeview.cpp.

◆ dragEnterEvent()

void QgsLayerTreeView::dragEnterEvent ( QDragEnterEvent *  event)
overrideprotected

Definition at line 672 of file qgslayertreeview.cpp.

◆ dragMoveEvent()

void QgsLayerTreeView::dragMoveEvent ( QDragMoveEvent *  event)
overrideprotected

Definition at line 686 of file qgslayertreeview.cpp.

◆ dropEvent()

void QgsLayerTreeView::dropEvent ( QDropEvent *  event)
overrideprotected

Definition at line 700 of file qgslayertreeview.cpp.

◆ expandAllNodes

void QgsLayerTreeView::expandAllNodes ( )
slot

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

Definition at line 568 of file qgslayertreeview.cpp.

◆ hideValidLayers()

bool QgsLayerTreeView::hideValidLayers ( ) const

Returns if valid layers should be hidden (i.e.

only invalid layers are shown).

See also
setHideValidLayers()
Since
QGIS 3.38

Definition at line 616 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 810 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 795 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 515 of file qgslayertreeview.cpp.

◆ keyPressEvent()

void QgsLayerTreeView::keyPressEvent ( QKeyEvent *  event)
overrideprotected

Definition at line 644 of file qgslayertreeview.cpp.

◆ layerForIndex()

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

Definition at line 373 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 335 of file qgslayertreeview.h.

◆ layerTreeModel()

QgsLayerTreeModel * QgsLayerTreeView::layerTreeModel ( ) const

Gets access to the model casted to QgsLayerTreeModel.

Definition at line 131 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 815 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 820 of file qgslayertreeview.cpp.

◆ menuProvider()

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::menuProvider ( ) const
inline

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

Definition at line 219 of file qgslayertreeview.h.

◆ modelRowsInserted

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

Definition at line 200 of file qgslayertreeview.cpp.

◆ modelRowsRemoved

void QgsLayerTreeView::modelRowsRemoved ( )
protectedslot

Definition at line 271 of file qgslayertreeview.cpp.

◆ mouseDoubleClickEvent()

void QgsLayerTreeView::mouseDoubleClickEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 621 of file qgslayertreeview.cpp.

◆ mouseReleaseEvent()

void QgsLayerTreeView::mouseReleaseEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 629 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 800 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 805 of file qgslayertreeview.cpp.

◆ onCurrentChanged

void QgsLayerTreeView::onCurrentChanged ( )
protectedslot

Definition at line 302 of file qgslayertreeview.cpp.

◆ onExpandedChanged

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

Definition at line 334 of file qgslayertreeview.cpp.

◆ onModelReset

void QgsLayerTreeView::onModelReset ( )
protectedslot

Definition at line 357 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 790 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 527 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 509 of file qgslayertreeview.cpp.

◆ resizeEvent()

void QgsLayerTreeView::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 726 of file qgslayertreeview.cpp.

◆ selectedLayerNodes()

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

Returns the list of selected nodes filtered to just layer nodes (QgsLayerTreeLayer).

See also
selectedNodes()
selectedLayers()
selectedLegendNodes()

Definition at line 438 of file qgslayertreeview.cpp.

◆ selectedLayers()

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

Returns the list of selected layers.

See also
selectedNodes()
selectedLayerNodes()
selectedLegendNodes()

Definition at line 451 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 481 of file qgslayertreeview.cpp.

◆ selectedLegendNodes()

QList< QgsLayerTreeModelLegendNode * > QgsLayerTreeView::selectedLegendNodes ( ) const

Returns the list of selected legend nodes.

See also
selectedNodes()
selectedLayerNodes()
Since
QGIS 3.32

Definition at line 464 of file qgslayertreeview.cpp.

◆ selectedNodes()

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

Returns the list of selected layer tree nodes.

Parameters
skipInternalIf true, will ignore nodes which have an ancestor in the selection
See also
selectedLayerNodes()
selectedLegendNodes()
selectedLayers()

Definition at line 427 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 154 of file qgslayertreeview.cpp.

◆ setHideValidLayers

void QgsLayerTreeView::setHideValidLayers ( bool  hideValid)
slot

Sets whether valid layers should be hidden (i.e.

only invalid layers are shown).

See also
setHideValidLayers()
Since
QGIS 3.38

Definition at line 605 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 385 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 169 of file qgslayertreeview.cpp.

◆ setMenuProvider()

void QgsLayerTreeView::setMenuProvider ( QgsLayerTreeViewMenuProvider menuProvider)

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

Definition at line 143 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 582 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 87 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 599 of file qgslayertreeview.cpp.

◆ showPrivateLayers()

bool QgsLayerTreeView::showPrivateLayers ( ) const

Returns the show private layers status.

Since
QGIS 3.18

Definition at line 611 of file qgslayertreeview.cpp.

◆ updateExpandedStateFromNode()

void QgsLayerTreeView::updateExpandedStateFromNode ( QgsLayerTreeNode node)
protected

Definition at line 363 of file qgslayertreeview.cpp.

◆ updateExpandedStateToNode

void QgsLayerTreeView::updateExpandedStateToNode ( const QModelIndex &  index)
protectedslot

Definition at line 277 of file qgslayertreeview.cpp.

Friends And Related Function Documentation

◆ QgsLayerTreeViewItemDelegate

friend class QgsLayerTreeViewItemDelegate
friend

Definition at line 486 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 464 of file qgslayertreeview.h.

◆ mDefaultActions

QgsLayerTreeViewDefaultActions* QgsLayerTreeView::mDefaultActions = nullptr
protected

helper class with default actions. Lazily initialized.

Definition at line 460 of file qgslayertreeview.h.

◆ mIndicators

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

Storage of indicators used with the tree view.

Definition at line 466 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 468 of file qgslayertreeview.h.

◆ mLayerMarkWidth

int QgsLayerTreeView::mLayerMarkWidth
protected

Width of contextual menu mark for layer nodes.

Definition at line 471 of file qgslayertreeview.h.

◆ mMenuProvider

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::mMenuProvider = nullptr
protected

Context menu provider. Owned by the view.

Definition at line 462 of file qgslayertreeview.h.


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