QGIS API Documentation: QgsLayerTreeRegistryBridge Class Reference

QGIS API Documentation 3.18.1-Zürich (202f1bf7e5)

Listens to the updates in map layer registry and does changes in layer tree. More...

#include <qgslayertreeregistrybridge.h>

Inheritance diagram for QgsLayerTreeRegistryBridge:

Inheritance graph

[legend]

Classes
struct	InsertionPoint
	A structure to define the insertion point to the layer tree. More...

Signals
void	addedLayersToLayerTree (const QList< QgsMapLayer * > &layers)
	Tell others we have just added layers to the tree (used in QGIS to auto-select first newly added layer) More...

Public Member Functions
	QgsLayerTreeRegistryBridge (QgsLayerTreeGroup root, QgsProject project, QObject *parent=nullptr)
	Create the instance that synchronizes given project with a layer tree root. More...

bool	isEnabled () const

bool	newLayersVisible () const

void	setEnabled (bool enabled)

void	setLayerInsertionPoint (const InsertionPoint &insertionPoint)
	Set where the new layers should be inserted - can be used to follow current selection. More...

Q_DECL_DEPRECATED void	setLayerInsertionPoint (QgsLayerTreeGroup *parentGroup, int index)
	Set where the new layers should be inserted - can be used to follow current selection. More...

void	setNewLayersVisible (bool enabled)

Protected Slots
void	groupRemovedChildren ()

void	groupWillRemoveChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo)

void	layersAdded (const QList< QgsMapLayer * > &layers)

void	layersWillBeRemoved (const QStringList &layerIds)

void	removeLayersFromRegistry (const QStringList &layerIds)

Protected Attributes
bool	mEnabled

InsertionPoint	mInsertionPoint

QStringList	mLayerIdsForRemoval

bool	mNewLayersVisible

QgsProject *	mProject = nullptr

bool	mRegistryRemovingLayers

QgsLayerTreeGroup *	mRoot = nullptr

Detailed Description

Listens to the updates in map layer registry and does changes in layer tree.

When connected to a layer tree, any layers added to the map layer registry will be also added to the layer tree. Similarly, map layers that are removed from registry will be removed from the layer tree.

If a layer is completely removed from the layer tree, it will be also removed from the map layer registry.

Since: QGIS 2.4

Definition at line 44 of file qgslayertreeregistrybridge.h.

Constructor & Destructor Documentation

◆ QgsLayerTreeRegistryBridge()

QgsLayerTreeRegistryBridge::QgsLayerTreeRegistryBridge	(	QgsLayerTreeGroup *	root,
		QgsProject *	project,
		QObject *	parent = `nullptr`
	)

explicit

Create the instance that synchronizes given project with a layer tree root.

Definition at line 23 of file qgslayertreeregistrybridge.cpp.

Member Function Documentation

◆ addedLayersToLayerTree

void QgsLayerTreeRegistryBridge::addedLayersToLayerTree ( const QList< QgsMapLayer * > & layers )

signal

Tell others we have just added layers to the tree (used in QGIS to auto-select first newly added layer)

Since: QGIS 2.6

◆ groupRemovedChildren

void QgsLayerTreeRegistryBridge::groupRemovedChildren ( )

protectedslot

Definition at line 132 of file qgslayertreeregistrybridge.cpp.

◆ groupWillRemoveChildren

void QgsLayerTreeRegistryBridge::groupWillRemoveChildren	(	QgsLayerTreeNode *	node,
		int	indexFrom,
		int	indexTo
	)

protectedslot

Definition at line 119 of file qgslayertreeregistrybridge.cpp.

◆ isEnabled()

bool QgsLayerTreeRegistryBridge::isEnabled ( ) const

inline

Definition at line 68 of file qgslayertreeregistrybridge.h.

◆ layersAdded

void QgsLayerTreeRegistryBridge::layersAdded ( const QList< QgsMapLayer * > & layers )

protectedslot

Definition at line 50 of file qgslayertreeregistrybridge.cpp.

◆ layersWillBeRemoved

void QgsLayerTreeRegistryBridge::layersWillBeRemoved ( const QStringList & layerIds )

protectedslot

Definition at line 80 of file qgslayertreeregistrybridge.cpp.

◆ newLayersVisible()

bool QgsLayerTreeRegistryBridge::newLayersVisible ( ) const

inline

Definition at line 71 of file qgslayertreeregistrybridge.h.

◆ removeLayersFromRegistry

void QgsLayerTreeRegistryBridge::removeLayersFromRegistry ( const QStringList & layerIds )

protectedslot

Definition at line 154 of file qgslayertreeregistrybridge.cpp.

◆ setEnabled()

void QgsLayerTreeRegistryBridge::setEnabled ( bool enabled )

inline

Definition at line 67 of file qgslayertreeregistrybridge.h.

◆ setLayerInsertionPoint() [1/2]

void QgsLayerTreeRegistryBridge::setLayerInsertionPoint ( const InsertionPoint & insertionPoint )

Set where the new layers should be inserted - can be used to follow current selection.

By default it is root group with zero index.

Since: QGIS 3.10

Definition at line 45 of file qgslayertreeregistrybridge.cpp.

◆ setLayerInsertionPoint() [2/2]

void QgsLayerTreeRegistryBridge::setLayerInsertionPoint	(	QgsLayerTreeGroup *	parentGroup,
		int	index
	)

Set where the new layers should be inserted - can be used to follow current selection.

By default it is root group with zero index.

Deprecated:: since QGIS 3.10 use setLayerInsertionPoint( const InsertionPoint &insertionPoint ) instead

Definition at line 39 of file qgslayertreeregistrybridge.cpp.

◆ setNewLayersVisible()

void QgsLayerTreeRegistryBridge::setNewLayersVisible ( bool enabled )

inline

Definition at line 70 of file qgslayertreeregistrybridge.h.

Member Data Documentation

◆ mEnabled

bool QgsLayerTreeRegistryBridge::mEnabled

protected

Definition at line 109 of file qgslayertreeregistrybridge.h.

◆ mInsertionPoint

InsertionPoint QgsLayerTreeRegistryBridge::mInsertionPoint

protected

Definition at line 112 of file qgslayertreeregistrybridge.h.

◆ mLayerIdsForRemoval

QStringList QgsLayerTreeRegistryBridge::mLayerIdsForRemoval

protected

Definition at line 107 of file qgslayertreeregistrybridge.h.

◆ mNewLayersVisible

bool QgsLayerTreeRegistryBridge::mNewLayersVisible

protected

Definition at line 110 of file qgslayertreeregistrybridge.h.

◆ mProject

QgsProject* QgsLayerTreeRegistryBridge::mProject = nullptr

protected

Definition at line 106 of file qgslayertreeregistrybridge.h.

◆ mRegistryRemovingLayers

bool QgsLayerTreeRegistryBridge::mRegistryRemovingLayers

protected

Definition at line 108 of file qgslayertreeregistrybridge.h.

◆ mRoot

QgsLayerTreeGroup* QgsLayerTreeRegistryBridge::mRoot = nullptr

protected

Definition at line 105 of file qgslayertreeregistrybridge.h.

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

/build/qgis-3.18.1+99unstable/src/core/layertree/qgslayertreeregistrybridge.h
/build/qgis-3.18.1+99unstable/src/core/layertree/qgslayertreeregistrybridge.cpp