Class: QgsStyleProxyModel¶

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

See also

QgsStyleModel

Added in version 3.4.

Class Hierarchy¶

Base classes¶

QSortFilterProxyModel
QAbstractProxyModel
QAbstractItemModel
QObject

Methods

`addDesiredIconSize`	Adds an additional icon size to generate for Qt.DecorationRole data.
`addTargetScreenProperties`	Adds additional target screen properties to use when generating icons for Qt.DecorationRole data.
`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.
`filterString`	Returns the current filter string, if set.
`layerType`	Returns the layer type filter, or `Qgis`.GeometryType.Unknown if no layer type filter is present.
`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.
`setLayerType`	Sets the layer type filter.
`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.
`setTagString`	Sets a tag 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.
`tagString`	Returns the tag string used to filter style entities by.

class qgis.core.QgsStyleProxyModel[source]¶

Bases: QSortFilterProxyModel

__init__(style: QgsStyle | None, parent: QObject | None = None)

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

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

Parameters:

style (Optional[QgsStyle])
parent (Optional[QObject] = None)

__init__(model: QgsStyleModel | None, parent: QObject | None = None)

Constructor for QgsStyleProxyModel, using the specified source model and parent object.

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

Parameters:

model (Optional[QgsStyleModel])
parent (Optional[QObject] = None)

__init__(model: QgsCombinedStyleModel | None, parent: QObject | None = None)

Constructor for QgsStyleProxyModel, using the specified source combined model and parent object.

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

Note

This is only available on builds based on Qt 5.13 or later.

Added in version 3.26.

Parameters:

model (Optional[QgsCombinedStyleModel])
parent (Optional[QObject] = None)

addDesiredIconSize(self, size: QSize)[source]¶

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)

addTargetScreenProperties(self, properties: QgsScreenProperties)[source]¶

Adds additional target screen properties to use when generating icons for Qt.DecorationRole data.

This allows style icons to be generated at an icon device pixel ratio and DPI which corresponds exactly to the view’s screen properties in which this model is used.

Added in version 3.32.

Parameters:: properties (QgsScreenProperties)

entityFilter(self) → QgsStyle.StyleEntity[source]¶

Returns the style entity type filter.

Note

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

See also

setEntityFilter()

Return type:: QgsStyle.StyleEntity

entityFilterEnabled(self) → bool[source]¶

Returns True if filtering by entity type is enabled.

See also

setEntityFilterEnabled()

See also

entityFilter()

Return type:: bool

favoritesOnly(self) → bool[source]¶

Returns True if the model is showing only favorited entities.

See also

setFavoritesOnly()

Return type:: bool

filterString(self) → str[source]¶

Returns the current filter string, if set.

See also

setFilterString()

Return type:: str

layerType(self) → Qgis.GeometryType[source]¶

Returns the layer type filter, or Qgis.GeometryType.Unknown if no layer type filter is present.

This setting has an effect on label settings entities and 3d symbols only.

See also

setLayerType()

Return type:: Qgis.GeometryType

setEntityFilter(self, filter: QgsStyle.StyleEntity)[source]¶

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)[source]¶

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.

See also

entityFilterEnabled()

See also

setEntityFilter()

Parameters:: enabled (bool)

setFavoritesOnly(self, favoritesOnly: bool)[source]¶

Sets whether the model should show only favorited entities.

See also

setFavoritesOnly()

Parameters:: favoritesOnly (bool)

setFilterString(self, filter: str | None)[source]¶

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

See also

filterString()

Parameters:: filter (Optional[str])

setLayerType(self, type: Qgis.GeometryType)[source]¶

Sets the layer type filter. Set type to Qgis.GeometryType.Unknown if no layer type filter is desired.

See also

layerType()

Parameters:: type (Qgis.GeometryType)

setSmartGroupId(self, id: int)[source]¶

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.

Note

This method has no effect for models created using QgsCombinedStyleModel source models.

See also

smartGroupId()

Parameters:: id (int)

setSymbolType(self, type: Qgis.SymbolType)[source]¶

Sets the symbol type filter.

Note

This filter is only active if Qgis.SymbolTypeFilterEnabled() is True.

See also

Qgis.SymbolType

Parameters:: type (Qgis.SymbolType)

setSymbolTypeFilterEnabled(self, enabled: bool)[source]¶

Sets whether filtering by symbol type is enabled.

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

See also

Qgis.SymbolTypeFilterEnabled

See also

setSymbolType()