Class: QgsStyleProxyModel

class qgis.core.QgsStyleProxyModel(style: QgsStyle, parent: QObject = None)

Bases: PyQt5.QtCore.QSortFilterProxyModel

Constructor for QgsStyleProxyModel, for the specified style and parent object.

The style object must exist for the lifetime of this model.

QgsStyleProxyModel(model: QgsStyleModel, parent: QObject = None) Constructor for QgsStyleProxyModel, using the specified source model and parent object.

The source model object must exist for the lifetime of this model.

A QSortFilterProxyModel subclass for showing filtered symbol and color ramps entries from a QgsStyle database.

See also

QgsStyleModel

New in version 3.4.

Parameters
addDesiredIconSize(self, size: QSize)

Adds an additional icon size to generate for Qt.DecorationRole data.

This allows style icons to be generated at an icon size which corresponds exactly to the view’s icon size in which this model is used.

Parameters

size (QSize) –

beginInsertColumns()
beginInsertRows()
beginMoveColumns()
beginMoveRows()
beginRemoveColumns()
beginRemoveRows()
beginResetModel()
changePersistentIndex()
changePersistentIndexList()
childEvent()
connectNotify()
createIndex()
customEvent()
decodeData()
disconnectNotify()
encodeData()
endInsertColumns()
endInsertRows()
endMoveColumns()
endMoveRows()
endRemoveColumns()
endRemoveRows()
endResetModel()
entityFilter(self) → QgsStyle.StyleEntity

Returns the style entity type filter.

Note

This filter is only active if entityFilterEnabled() is True.

Return type

QgsStyle.StyleEntity

entityFilterEnabled(self) → bool

Returns True if filtering by entity type is enabled.

See also

entityFilter()

Return type

bool

favoritesOnly(self) → bool

Returns True if the model is showing only favorited entities.

Return type

bool

filterAcceptsColumn()
filterAcceptsRow(self, source_row: int, source_parent: QModelIndex) → bool
Parameters
  • source_row (int) –

  • source_parent (QModelIndex) –

Return type

bool

filterString(self) → str

Returns the current filter string, if set.

Return type

str

invalidateFilter()
isSignalConnected()
layerType(self) → QgsWkbTypes.GeometryType

Returns the layer type filter, or QgsWkbTypes.UnknownGeometry if no layer type filter is present.

This setting has no effect on non-label settings entities (i.e. color ramps).

See also

setLayerType()

Return type

QgsWkbTypes.GeometryType

lessThan()
persistentIndexList()
receivers()
resetInternalData()
sender()
senderSignalIndex()
setEntityFilter(self, filter: QgsStyle.StyleEntity)

Sets the style entity type filter.

Note

This filter is only active if entityFilterEnabled() is True.

See also

entityFilter()

Parameters

filter (QgsStyle.StyleEntity) –

setEntityFilterEnabled(self, enabled: bool)

Sets whether filtering by entity type is enabled.

If enabled is False, then the value of entityFilter() will have no effect on the model filtering.

Parameters

enabled (bool) –

setFavoritesOnly(self, favoritesOnly: bool)

Sets whether the model should show only favorited entities.

Parameters

favoritesOnly (bool) –

setFilterString(self, filter: str)

Sets a filter string, such that only symbol entities with names matching the specified string will be shown.

See also

filterString()

Parameters

filter (str) –

setLayerType(self, type: QgsWkbTypes.GeometryType)

Sets the layer type filter. Set type to QgsWkbTypes.UnknownGeometry if no layer type filter is desired.

See also

layerType()

Parameters

type (QgsWkbTypes.GeometryType) –

setSmartGroupId(self, id: int)

Sets a smart group id to filter style entities by. Only entities within the given smart group will be shown in the model.

Set id to -1 to disable smart group filtering.

See also

smartGroupId()

Parameters

id (int) –

setSymbolType(self, type: QgsSymbol.SymbolType)

Sets the symbol type filter.

Note

This filter is only active if symbolTypeFilterEnabled() is True.

See also

symbolType()

Parameters

type (QgsSymbol.SymbolType) –

setSymbolTypeFilterEnabled(self, enabled: bool)

Sets whether filtering by symbol type is enabled.

If enabled is False, then the value of symbolType() will have no effect on the model filtering. This has no effect on non-symbol entities (i.e. color ramps).

See also

setSymbolType()

Parameters

enabled (bool) –

setTagId(self, id: int)

Sets a tag id to filter style entities by. Only entities with the given tag will be shown in the model.

Set id to -1 to disable tag filtering.

See also

tagId()

Parameters

id (int) –

smartGroupId(self) → int

Returns the smart group id used to filter style entities by.

If returned value is -1, then no smart group filtering is being conducted.

Return type

int

symbolType(self) → QgsSymbol.SymbolType

Returns the symbol type filter.

Note

This filter is only active if symbolTypeFilterEnabled() is True, and has no effect on non-symbol entities (i.e. color ramps).

See also

setSymbolType()

Return type

QgsSymbol.SymbolType

symbolTypeFilterEnabled(self) → bool

Returns True if filtering by symbol type is enabled.

See also

symbolType()

Return type

bool

tagId(self) → int

Returns the tag id used to filter style entities by.

If returned value is -1, then no tag filtering is being conducted.

See also

setTagId()

Return type

int

timerEvent()