Class: QgsLayerTreeProxyModel

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

Added in version 3.18.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsLayerTreeProxyModel

Base classes

QSortFilterProxyModel

QAbstractProxyModel

QAbstractItemModel

QObject

Methods

hideValidLayers

Returns if valid layers should be hidden (i.e. only invalid layers are shown).

setFilterText

Sets filter to filterText.

setHideValidLayers

Sets whether valid layers should be hidden (i.e. only invalid layers are shown).

setShowPrivateLayers

Determines if private layers are shown.

showPrivateLayers

Returns if private layers are shown.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsLayerTreeProxyModel. See the FAQ for more details.

nodeShown

Returns True if the specified node should be shown.

class qgis.gui.QgsLayerTreeProxyModel[source]

Bases: QSortFilterProxyModel

__init__(treeModel: QgsLayerTreeModel | None, parent: QObject | None)

Constructs QgsLayerTreeProxyModel with source model treeModel and a parent

Parameters:
hideValidLayers(self) bool[source]

Returns if valid layers should be hidden (i.e. only invalid layers are shown).

Added in version 3.38.

Return type:

bool

virtual nodeShown(self, node: QgsLayerTreeNode | None) bool[source]

Returns True if the specified node should be shown.

Added in version 4.0.

Parameters:

node (Optional[QgsLayerTreeNode])

Return type:

bool

setFilterText(self, filterText: str | None = '')[source]

Sets filter to filterText.

Parameters:

filterText (Optional[str] = '')

setHideValidLayers(self, hideValid: bool)[source]

Sets whether valid layers should be hidden (i.e. only invalid layers are shown).

Added in version 3.38.

Parameters:

hideValid (bool)

setShowPrivateLayers(self, showPrivate: bool)[source]

Determines if private layers are shown.

Parameters:

showPrivate (bool)

showPrivateLayers(self) bool[source]

Returns if private layers are shown.

Return type:

bool