QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Protected Member Functions | List of all members
QgsLayerTreeProxyModel Class Reference

The QgsLayerTreeProxyModel class is a proxy model for QgsLayerTreeModel, supports private layers and text filtering. More...

#include <qgslayertreeview.h>

Inheritance diagram for QgsLayerTreeProxyModel:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

bool filterAcceptsRow (int sourceRow, const QModelIndex &sourceParent) const override
 

Detailed Description

The QgsLayerTreeProxyModel class is a proxy model for QgsLayerTreeModel, supports private layers and text filtering.

Since
QGIS 3.18

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

Member Function Documentation

◆ filterAcceptsRow()

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

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

◆ setFilterText()

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

Sets filter to filterText.

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

◆ setShowPrivateLayers()

void QgsLayerTreeProxyModel::setShowPrivateLayers ( bool  showPrivate)

Determines if private layers are shown.

Definition at line 879 of file qgslayertreeview.cpp.

◆ showPrivateLayers()

bool QgsLayerTreeProxyModel::showPrivateLayers ( ) const

Returns if private layers are shown.

Definition at line 874 of file qgslayertreeview.cpp.


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