Subgroup: Browser

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: Methods

beginInsertColumns
beginInsertRows
beginMoveColumns
beginMoveRows
beginRemoveColumns
beginRemoveRows
beginResetModel
browserModel Returns the underlying browser model.
caseSensitivity Returns whether item filtering is case sensitive.
changePersistentIndex
changePersistentIndexList
childEvent
connectNotify
createIndex
customEvent
dataItem Returns the data item at the specified proxy index, or a None if no item exists at the index.
decodeData
disconnectNotify
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
filterAcceptsColumn
filterAcceptsRow
filterByLayerType Returns true if the model is filtered by map layer type.
filterString Returns the filter string used when filtering items in the model.
filterSyntax Returns the filter syntax.
invalidateFilter
isSignalConnected
layerType Returns the layer type to filter the model by.
lessThan
persistentIndexList
receivers
resetInternalData
sender
senderSignalIndex
setBrowserModel Sets the underlying browser model.
setFilterByLayerType Sets whether the model is filtered by map layer type.
setFilterCaseSensitivity Sets whether item filtering should be case sensitive.
setFilterString Sets the filter string to use when filtering items in the model.
setFilterSyntax Sets the filter syntax.
setLayerType Sets the layer type to filter the model by.
timerEvent

Signals

Attributes

Normal
RegularExpression
Wildcards
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.

caseSensitivity(self) → Qt.CaseSensitivity

Returns whether item filtering is case sensitive.

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.

decodeData()
disconnectNotify()
encodeData()
endInsertColumns()
endInsertRows()
endMoveColumns()
endMoveRows()
endRemoveColumns()
endRemoveRows()
endResetModel()
filterAcceptsColumn()
filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex) → bool
filterByLayerType(self) → bool

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

See also

layerType()

filterString(self) → str

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

filterSyntax(self) → QgsBrowserProxyModel.FilterSyntax

Returns the filter syntax.

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()

lessThan()
persistentIndexList()
receivers()
resetInternalData()
sender()
senderSignalIndex()
setBrowserModel(self, model: QgsBrowserModel)

Sets the underlying browser model.

See also

browserModel()

setFilterByLayerType(self, enabled: bool)

Sets whether the model is filtered by map layer type.

See also

setLayerType()

setFilterCaseSensitivity(self, sensitivity: Qt.CaseSensitivity)

Sets whether item filtering should be case sensitive.

setFilterString(self, filter: str)

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

See also

filterString()

setFilterSyntax(self, syntax: QgsBrowserProxyModel.FilterSyntax)

Sets the filter syntax.

See also

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()

timerEvent()