Class: QgsLayerTreeProxyModel

class qgis.gui.QgsLayerTreeProxyModel

Bases: PyQt5.QtCore.QSortFilterProxyModel

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

Added in version 3.18.

QgsLayerTreeProxyModel(treeModel: Optional[QgsLayerTreeModel], parent: Optional[QObject]) Constructs QgsLayerTreeProxyModel with source model treeModel and a parent

beginInsertColumns(self, parent: QModelIndex, first: int, last: int)
beginInsertRows(self, parent: QModelIndex, first: int, last: int)
beginMoveColumns(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationColumn: int) → bool
beginMoveRows(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationRow: int) → bool
beginRemoveColumns(self, parent: QModelIndex, first: int, last: int)
beginRemoveRows(self, parent: QModelIndex, first: int, last: int)
beginResetModel(self)
changePersistentIndex(self, from_: QModelIndex, to: QModelIndex)
changePersistentIndexList(self, from_: Iterable[QModelIndex], to: Iterable[QModelIndex])
childEvent(self, a0: QChildEvent | None)
connectNotify(self, signal: QMetaMethod)
createIndex(self, row: int, column: int, object: Any = None) → QModelIndex
customEvent(self, a0: QEvent | None)
decodeData(self, row: int, column: int, parent: QModelIndex, stream: QDataStream) → bool
disconnectNotify(self, signal: QMetaMethod)
encodeData(self, indexes: Iterable[QModelIndex], stream: QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
filterAcceptsColumn(self, source_column: int, source_parent: QModelIndex) → bool
filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex) → bool
Parameters:

  • sourceRow (int)

  • sourceParent (QModelIndex)

Return type:

bool

invalidateFilter(self)
isSignalConnected(self, signal: QMetaMethod) → bool
lessThan(self, left: QModelIndex, right: QModelIndex) → bool
persistentIndexList(self) → List[QModelIndex]
receivers(self, signal: PYQT_SIGNAL) → int
resetInternalData(self)
sender(self) → QObject | None
senderSignalIndex(self) → int
setFilterText(self, filterText: str | None = '')

Sets filter to filterText.

Parameters:

filterText (Optional[str] = '')

setShowPrivateLayers(self, showPrivate: bool)

Determines if private layers are shown.

Parameters:

showPrivate (bool)

showPrivateLayers(self) → bool

Returns if private layers are shown.

Return type:

bool

timerEvent(self, a0: QTimerEvent | None)