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.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createPaintEffect()

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)

abstract 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

virtual 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