A proxy model for QgsLayerTreeModel, supporting private layers and text filtering. More...

#include <qgslayertreeview.h>

Inheritance diagram for QgsLayerTreeProxyModel:

Public Member Functions
	QgsLayerTreeProxyModel (QgsLayerTreeModel treeModel, QObject parent)
	Constructs QgsLayerTreeProxyModel with source model treeModel and a parent.
bool	hideValidLayers () const
	Returns if valid layers should be hidden (i.e.
void	setFilterText (const QString &filterText=QString())
	Sets filter to filterText.
void	setHideValidLayers (bool hideValid)
	Sets whether valid layers should be hidden (i.e.
void	setShowPrivateLayers (bool showPrivate)
	Determines if private layers are shown.
bool	showPrivateLayers () const
	Returns if private layers are shown.

Protected Member Functions
bool	filterAcceptsRow (int sourceRow, const QModelIndex &sourceParent) const override
virtual bool	nodeShown (QgsLayerTreeNode *node) const
	Returns `true` if the specified node should be shown.

Detailed Description

A proxy model for QgsLayerTreeModel, supporting private layers and text filtering.

Since: QGIS 3.18

Definition at line 47 of file qgslayertreeview.h.

Constructor & Destructor Documentation

◆ QgsLayerTreeProxyModel()

QgsLayerTreeProxyModel::QgsLayerTreeProxyModel	(	QgsLayerTreeModel *	treeModel,
		QObject *	parent )

Constructs QgsLayerTreeProxyModel with source model treeModel and a parent.

Definition at line 960 of file qgslayertreeview.cpp.

Member Function Documentation

◆ filterAcceptsRow()

bool QgsLayerTreeProxyModel::filterAcceptsRow	(	int	sourceRow,
		const QModelIndex &	sourceParent ) const

overrideprotected

Definition at line 976 of file qgslayertreeview.cpp.

◆ hideValidLayers()

bool QgsLayerTreeProxyModel::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 1023 of file qgslayertreeview.cpp.

◆ nodeShown()

bool QgsLayerTreeProxyModel::nodeShown ( QgsLayerTreeNode * node ) const

protectedvirtual

Returns true if the specified node should be shown.

Since: QGIS 4.0

Definition at line 982 of file qgslayertreeview.cpp.

◆ setFilterText()

void QgsLayerTreeProxyModel::setFilterText ( const QString & filterText = QString() )

Sets filter to filterText.

Definition at line 967 of file qgslayertreeview.cpp.

◆ setHideValidLayers()

void QgsLayerTreeProxyModel::setHideValidLayers ( bool hideValid )

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

only invalid layers are shown).

See also: setHideValidLayers()

Since: QGIS 3.38

Definition at line 1028 of file qgslayertreeview.cpp.

◆ setShowPrivateLayers()

void QgsLayerTreeProxyModel::setShowPrivateLayers ( bool showPrivate )

Determines if private layers are shown.

Definition at line 1014 of file qgslayertreeview.cpp.

◆ showPrivateLayers()

bool QgsLayerTreeProxyModel::showPrivateLayers ( ) const

Returns if private layers are shown.

Definition at line 1009 of file qgslayertreeview.cpp.

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

/build/qgis-3.99.0+git20251214+752b475928d+99sid/src/gui/layertree/qgslayertreeview.h
/build/qgis-3.99.0+git20251214+752b475928d+99sid/src/gui/layertree/qgslayertreeview.cpp

Public Member Functions

Protected Member Functions