QgsLayerTreeView Class Reference

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

#include <qgslayertreeview.h>

Public Slots
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.

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

Public Member Functions
	QgsLayerTreeView (QWidget *parent=0)
	~QgsLayerTreeView ()
virtual void	setModel (QAbstractItemModel *model)
	Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model.
QgsLayerTreeModel *	layerTreeModel () const
	Get access to the model casted to QgsLayerTreeModel.
QgsLayerTreeViewDefaultActions *	defaultActions ()
	Get access to the default actions that may be used with the tree view.
void	setMenuProvider (QgsLayerTreeViewMenuProvider *menuProvider)
	Set provider for context menu. Takes ownership of the instance.
QgsLayerTreeViewMenuProvider *	menuProvider () const
	Return pointer to the context menu provider. May be null.
QgsMapLayer *	currentLayer () const
	Get currently selected layer. May be null.
void	setCurrentLayer (QgsMapLayer *layer)
	Set currently selected layer. Null pointer will deselect any layer.
QgsLayerTreeNode *	currentNode () const
	Get current node. May be null.
QgsLayerTreeGroup *	currentGroupNode () const
	Get current group node. If a layer is current node, the function will return parent group. May be null.
QList< QgsLayerTreeNode * >	selectedNodes (bool skipInternal=false) const
	Return list of selected nodes.
QList< QgsLayerTreeLayer * >	selectedLayerNodes () const
	Return list of selected nodes filtered to just layer nodes.
QList< QgsMapLayer * >	selectedLayers () const
	Get list of selected layers.

Protected Slots
void	modelRowsInserted (QModelIndex index, int start, int end)
void	modelRowsRemoved ()
void	updateExpandedStateToNode (QModelIndex index)
void	onCurrentChanged ()
void	onExpandedChanged (QgsLayerTreeNode *node, bool expanded)
void	onModelReset ()

Protected Member Functions
void	contextMenuEvent (QContextMenuEvent *event)
void	updateExpandedStateFromNode (QgsLayerTreeNode *node)
QgsMapLayer *	layerForIndex (const QModelIndex &index) const

Protected Attributes
QgsLayerTreeViewDefaultActions *	mDefaultActions
	helper class with default actions. Lazily initialized.
QgsLayerTreeViewMenuProvider *	mMenuProvider
	Context menu provider. Owned by the view.
QString	mCurrentLayerID
	Keeps track of current layer ID (to check when to emit signal about change of current layer)

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

Note

added in 2.4

Constructor & Destructor Documentation

QgsLayerTreeView::QgsLayerTreeView ( QWidget *  parent = 0 )

explicit

QgsLayerTreeView::~QgsLayerTreeView

(

)

Member Function Documentation

void QgsLayerTreeView::contextMenuEvent ( QContextMenuEvent *  event )

protected

QgsLayerTreeGroup * QgsLayerTreeView::currentGroupNode

(

)

const

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

QgsMapLayer * QgsLayerTreeView::currentLayer

(

)

const

Get currently selected layer. May be null.

void QgsLayerTreeView::currentLayerChanged ( QgsMapLayer *  layer )

signal

Emitted when a current layer is changed.

QgsLayerTreeNode * QgsLayerTreeView::currentNode

(

)

const

Get current node. May be null.

QgsLayerTreeViewDefaultActions * QgsLayerTreeView::defaultActions

(

)

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

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

protected

QgsLayerTreeModel * QgsLayerTreeView::layerTreeModel

(

)

const

Get access to the model casted to QgsLayerTreeModel.

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::menuProvider ( ) const

inline

Return pointer to the context menu provider. May be null.

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

protectedslot

void QgsLayerTreeView::modelRowsRemoved ( )

protectedslot

void QgsLayerTreeView::onCurrentChanged ( )

protectedslot

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

protectedslot

void QgsLayerTreeView::onModelReset ( )

protectedslot

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.

QList< QgsLayerTreeLayer * > QgsLayerTreeView::selectedLayerNodes

(

)

const

Return list of selected nodes filtered to just layer nodes.

QList< QgsMapLayer * > QgsLayerTreeView::selectedLayers

(

)

const

Get list of selected layers.

QList< QgsLayerTreeNode * > QgsLayerTreeView::selectedNodes

(

bool

skipInternal = false

)

const

Return list of selected nodes.

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

void QgsLayerTreeView::setCurrentLayer

(

QgsMapLayer *

layer

)

Set currently selected layer. Null pointer will deselect any layer.

void QgsLayerTreeView::setMenuProvider

(

QgsLayerTreeViewMenuProvider *

menuProvider

)

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

void QgsLayerTreeView::setModel ( QAbstractItemModel *  model )

virtual

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

void QgsLayerTreeView::updateExpandedStateFromNode ( QgsLayerTreeNode *  node )

protected

void QgsLayerTreeView::updateExpandedStateToNode ( QModelIndex  index )

protectedslot

Member Data Documentation

QString QgsLayerTreeView::mCurrentLayerID

protected

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

QgsLayerTreeViewDefaultActions* QgsLayerTreeView::mDefaultActions

protected

helper class with default actions. Lazily initialized.

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::mMenuProvider

protected

Context menu provider. Owned by the view.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/layertree/qgslayertreeview.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/layertree/qgslayertreeview.cpp