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.

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

See also

QgsStyleModel

New in version 3.4: Methods

addDesiredIconSize Adds an additional icon size to generate for Qt.DecorationRole data.
beginInsertColumns
beginInsertRows
beginMoveColumns
beginMoveRows
beginRemoveColumns
beginRemoveRows
beginResetModel
changePersistentIndex
changePersistentIndexList
childEvent
connectNotify
createIndex
customEvent
decodeData
disconnectNotify
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
entityFilter Returns the style entity type filter.
entityFilterEnabled Returns true if filtering by entity type is enabled.
favoritesOnly Returns true if the model is showing only favorited entities.
filterAcceptsColumn
filterAcceptsRow
filterString Returns the current filter string, if set.
invalidateFilter
isSignalConnected
lessThan
persistentIndexList
receivers
resetInternalData
sender
senderSignalIndex
setEntityFilter Sets the style entity type filter.
setEntityFilterEnabled Sets whether filtering by entity type is enabled.
setFavoritesOnly Sets whether the model should show only favorited entities.
setFilterString Sets a filter string, such that only symbol entities with names matching the specified string will be shown.
setSmartGroupId Sets a smart group id to filter style entities by.
setSymbolType Sets the symbol type filter.
setSymbolTypeFilterEnabled Sets whether filtering by symbol type is enabled.
setTagId Sets a tag id to filter style entities by.
smartGroupId Returns the smart group id used to filter style entities by.
symbolType Returns the symbol type filter.
symbolTypeFilterEnabled Returns true if filtering by symbol type is enabled.
tagId Returns the tag id used to filter style entities by.
timerEvent

Signals

Attributes

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.

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.

entityFilterEnabled(self) → bool

Returns true if filtering by entity type is enabled.

See also

entityFilter()

favoritesOnly(self) → bool

Returns true if the model is showing only favorited entities.

filterAcceptsColumn()
filterAcceptsRow(self, source_row: int, source_parent: QModelIndex) → bool
filterString(self) → str

Returns the current filter string, if set.

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

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.

setFavoritesOnly(self, favoritesOnly: bool)

Sets whether the model should show only favorited entities.

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

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

setSymbolType(self, type: QgsSymbol.SymbolType)

Sets the symbol type filter.

Note

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

See also

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

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

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.

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

symbolTypeFilterEnabled(self) → bool

Returns true if filtering by symbol type is enabled.

See also

symbolType()

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

timerEvent()