Class: QgsPaintEffectAbstractMetadata¶

Stores metadata about a paint effect class.

Note

It’s necessary to implement the createPaintEffect() function. In C++ you can use the QgsPaintEffectMetadata convenience class to simplify creation of the metadata.

Methods

`createPaintEffect`	Create a paint effect of this class given an encoded map of properties.
`createWidget`	Create configuration widget for paint effect of this class.
`name`	Returns the unique string representing the paint effect class
`visibleName`	Returns the user visible string representing the paint effect class

class qgis.core.QgsPaintEffectAbstractMetadata[source]¶

Bases: object

__init__(name: str | None, visibleName: str | None)

Construct a new QgsPaintEffectAbstractMetadata

Parameters:

name (Optional[str]) – unique string representing paint effect class
visibleName (Optional[str]) – user visible name representing paint effect class

__init__(a0: QgsPaintEffectAbstractMetadata)

Parameters:: a0 (QgsPaintEffectAbstractMetadata)

createPaintEffect(self, map: Dict[str, Any]) → QgsPaintEffect | None[source]¶

Create a paint effect of this class given an encoded map of properties.

Parameters:: map (Dict[str, Any]) – properties string map
Return type:: Optional[QgsPaintEffect]
Returns:: new paint effect

createWidget(self) → QgsPaintEffectWidget | None[source]¶

Create configuration widget for paint effect of this class. Can return None if there’s no GUI for the paint effect class.

Return type:: Optional[QgsPaintEffectWidget]
Returns:: configuration widget

name(self) → str[source]¶

Returns the unique string representing the paint effect class

Return type:: str
Returns:: unique string