QGIS API Documentation  3.9.0-Master (8986ea2301)
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 setLayerMarkWidth (int width)
 Set width of contextual menu mark, at right of layer node items. 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...
 
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...
 
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...
 
QgsLayerTreeViewMenuProvidermenuProvider () const
 Returns pointer to the context menu provider. May be nullptr. 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 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
 
QgsMapLayerlayerForIndex (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...
 
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
Since
QGIS 2.4

Definition at line 49 of file qgslayertreeview.h.

Constructor & Destructor Documentation

◆ QgsLayerTreeView()

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

Constructor for QgsLayerTreeView.

Definition at line 35 of file qgslayertreeview.cpp.

◆ ~QgsLayerTreeView()

QgsLayerTreeView::~QgsLayerTreeView ( )
override

Definition at line 67 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 398 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 477 of file qgslayertreeview.cpp.

◆ contextMenuEvent()

void QgsLayerTreeView::contextMenuEvent ( QContextMenuEvent *  event)
overrideprotected

Definition at line 131 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 335 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 110 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 357 of file qgslayertreeview.cpp.

◆ currentNode()

QgsLayerTreeNode * QgsLayerTreeView::currentNode ( ) const

Gets current node. May be nullptr.

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

◆ dropEvent()

void QgsLayerTreeView::dropEvent ( QDropEvent *  event)
overrideprotected

Definition at line 510 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 470 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 417 of file qgslayertreeview.cpp.

◆ keyPressEvent()

void QgsLayerTreeView::keyPressEvent ( QKeyEvent *  event)
overrideprotected

Definition at line 499 of file qgslayertreeview.cpp.

◆ layerForIndex()

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

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

◆ layerTreeModel()

QgsLayerTreeModel * QgsLayerTreeView::layerTreeModel ( ) const

Gets access to the model casted to QgsLayerTreeModel.

Definition at line 92 of file qgslayertreeview.cpp.

◆ menuProvider()

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::menuProvider ( ) const
inline

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

Definition at line 81 of file qgslayertreeview.h.

◆ modelRowsInserted

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

Definition at line 147 of file qgslayertreeview.cpp.

◆ modelRowsRemoved

void QgsLayerTreeView::modelRowsRemoved ( )
protectedslot

Definition at line 218 of file qgslayertreeview.cpp.

◆ mouseReleaseEvent()

void QgsLayerTreeView::mouseReleaseEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 484 of file qgslayertreeview.cpp.

◆ onCurrentChanged

void QgsLayerTreeView::onCurrentChanged ( )
protectedslot

Definition at line 249 of file qgslayertreeview.cpp.

◆ onExpandedChanged

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

Definition at line 270 of file qgslayertreeview.cpp.

◆ onModelReset

void QgsLayerTreeView::onModelReset ( )
protectedslot

Definition at line 293 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 429 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 411 of file qgslayertreeview.cpp.

◆ resizeEvent()

void QgsLayerTreeView::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 519 of file qgslayertreeview.cpp.

◆ selectedLayerNodes()

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

Returns list of selected nodes filtered to just layer nodes.

Definition at line 367 of file qgslayertreeview.cpp.

◆ selectedLayers()

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

Gets list of selected layers.

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

◆ selectedNodes()

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

Returns list of selected nodes.

Parameters
skipInternalIf true, will ignore nodes which have an ancestor in the selection

Definition at line 362 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 115 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 199 of file qgslayertreeview.h.

◆ setMenuProvider()

void QgsLayerTreeView::setMenuProvider ( QgsLayerTreeViewMenuProvider menuProvider)

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

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

◆ updateExpandedStateFromNode()

void QgsLayerTreeView::updateExpandedStateFromNode ( QgsLayerTreeNode node)
protected

Definition at line 298 of file qgslayertreeview.cpp.

◆ updateExpandedStateToNode

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

Definition at line 224 of file qgslayertreeview.cpp.

Friends And Related Function Documentation

◆ QgsLayerTreeViewItemDelegate

friend class QgsLayerTreeViewItemDelegate
friend

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

◆ mDefaultActions

QgsLayerTreeViewDefaultActions* QgsLayerTreeView::mDefaultActions = nullptr
protected

helper class with default actions. Lazily initialized.

Definition at line 235 of file qgslayertreeview.h.

◆ mIndicators

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

Storage of indicators used with the tree view.

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

◆ mLayerMarkWidth

int QgsLayerTreeView::mLayerMarkWidth
protected

Width of contextual menu mark for layer nodes.

Definition at line 246 of file qgslayertreeview.h.

◆ mMenuProvider

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::mMenuProvider = nullptr
protected

Context menu provider. Owned by the view.

Definition at line 237 of file qgslayertreeview.h.


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