Class: QgsPaintEffectRegistry¶

Registry of available paint effects.

QgsPaintEffectRegistry is not usually directly created, but rather accessed through QgsApplication.paintEffectRegistry().

Methods

`addEffectType`	Registers a new effect type.
`createEffect`	Creates a new paint effect given the effect name and properties map.
`effectMetadata`	Returns the metadata for a specific effect.
`effects`	Returns a list of known paint effects.

Static Methods

`defaultStack`	Returns a new effect stack consisting of a sensible selection of default effects.
`isDefaultStack`	Tests whether a paint effect matches the default effects stack.

class qgis.core.QgsPaintEffectRegistry[source]¶

Bases: object

addEffectType(self, metadata: QgsPaintEffectAbstractMetadata | None) → bool[source]¶

Registers a new effect type.

Parameters:: metadata (Optional[QgsPaintEffectAbstractMetadata]) – effect metadata. Ownership is transferred to the registry.
Return type:: bool
Returns:: True if add was successful.

createEffect(self, name: str | None, properties: Dict[str, Any] = {}) → QgsPaintEffect | None[source]¶

Creates a new paint effect given the effect name and properties map.

Parameters:

name (Optional[str]) – unique name representing paint effect class
properties (Dict[str, Any] = {}) – encoded string map of effect properties

Return type:

Optional[QgsPaintEffect]

Returns:

new paint effect of specified class, or None if matching paint effect could not be created

createEffect(self, element: QDomElement) → QgsPaintEffect | None[source]

Creates a new paint effect given a DOM element storing paint effect properties.

Parameters:: element (QDomElement) – encoded DOM element of effect properties
Return type:: Optional[QgsPaintEffect]
Returns:: new paint effect, or None if matching paint effect could not be created

static defaultStack() → QgsPaintEffect | None[source]¶

Returns a new effect stack consisting of a sensible selection of default effects. All effects except the standard draw source effect are disabled, but are included so that they can be easily drawn just by enabling the effect.

Return type:: Optional[QgsPaintEffect]
Returns:: default effects stack