Class: QgsBrowserProxyModel¶

class qgis.core.QgsBrowserProxyModel(parent: QObject = None)¶

Bases: PyQt5.QtCore.QSortFilterProxyModel

Constructor for QgsBrowserProxyModel, with the specified parent object.

A QSortFilterProxyModel subclass for filtering and sorting browser model items.

New in version 3.4.

Parameters: parent –

class FilterSyntax¶: Bases: int

Normal = 0¶

RegularExpression = 2¶

Wildcards = 1¶

beginInsertColumns()¶

beginInsertRows()¶

beginMoveColumns()¶

beginMoveRows()¶

beginRemoveColumns()¶

beginRemoveRows()¶

beginResetModel()¶

browserModel(self) → QgsBrowserModel¶

Returns the underlying browser model.

See also

setBrowserModel()

Return type: QgsBrowserModel

caseSensitivity(self) → Qt.CaseSensitivity¶

Returns whether item filtering is case sensitive.

See also

setFilterCaseSensitivity()

Return type: Qt.CaseSensitivity

changePersistentIndex()¶

changePersistentIndexList()¶

childEvent()¶

connectNotify()¶

createIndex()¶

customEvent()¶

dataItem(self, index: QModelIndex) → QgsDataItem¶

Returns the data item at the specified proxy index, or a None if no item exists at the index.

Parameters: index (QModelIndex) –
Return type: QgsDataItem

decodeData()¶

disconnectNotify()¶

encodeData()¶

endInsertColumns()¶

endInsertRows()¶

endMoveColumns()¶

endMoveRows()¶

endRemoveColumns()¶

endRemoveRows()¶

endResetModel()¶

filterAcceptsColumn()¶

filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex) → bool¶

Parameters

sourceRow (int) –
sourceParent (QModelIndex) –

Return type

bool

filterByLayerType(self) → bool¶

Returns true if the model is filtered by map layer type.

See also

layerType()

See also

setFilterByLayerType()

Return type: bool

filterString(self) → str¶

Returns the filter string used when filtering items in the model.

See also

setFilterString()

Return type: str

filterSyntax(self) → QgsBrowserProxyModel.FilterSyntax¶

Returns the filter syntax.

See also

setFilterSyntax()

Return type: QgsBrowserProxyModel.FilterSyntax

invalidateFilter()¶

isSignalConnected()¶

layerType(self) → QgsMapLayer.LayerType¶

Returns the layer type to filter the model by. This is only used if filterByLayerType() is true.

See also

setLayerType()

See also

filterByLayerType()

Return type: QgsMapLayer.LayerType

lessThan()¶

persistentIndexList()¶

receivers()¶

resetInternalData()¶

sender()¶

senderSignalIndex()¶

setBrowserModel(self, model: QgsBrowserModel)¶

Sets the underlying browser model.

See also

browserModel()

Parameters: model (QgsBrowserModel) –

setFilterByLayerType(self, enabled: bool)¶

Sets whether the model is filtered by map layer type.

See also

filterByLayerType()

See also

setLayerType()

Parameters: enabled (bool) –

setFilterCaseSensitivity(self, sensitivity: Qt.CaseSensitivity)¶

Sets whether item filtering should be case sensitive.

See also

caseSensitivity()

Parameters: sensitivity (Qt.CaseSensitivity) –

setFilterString(self, filter: str)¶

Sets the filter string to use when filtering items in the model.

See also

filterString()

Parameters: filter (str) –

setFilterSyntax(self, syntax: QgsBrowserProxyModel.FilterSyntax)¶

Sets the filter syntax.

See also

filterSyntax()

Parameters: syntax (QgsBrowserProxyModel.FilterSyntax) –

setLayerType(self, type: QgsMapLayer.LayerType)¶

Sets the layer type to filter the model by. This is only used if filterByLayerType() is true.

See also

layerType()

See also

setFilterByLayerType()

Parameters: type (QgsMapLayer.LayerType) –

timerEvent()¶