Class: QgsPaintEffectAbstractMetadata

class qgis.core.QgsPaintEffectAbstractMetadata(name: str, visibleName: str)

Bases: sip.wrapper

Construct a new QgsPaintEffectAbstractMetadata

Parameters
  • name – unique string representing paint effect class

  • visibleName – user visible name representing paint effect class

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

createPaintEffect(self, map: Dict[str, str])QgsPaintEffect

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

Parameters

map (Dict[str) – properties string map

Return type

QgsPaintEffect

Returns

new paint effect

createWidget(self)QgsPaintEffectWidget

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

Return type

QgsPaintEffectWidget

Returns

configuration widget

name(self)str

Returns the unique string representing the paint effect class

Return type

str

Returns

unique string

See also

visibleName()

visibleName(self)str

Returns the user visible string representing the paint effect class

Return type

str

Returns

friendly user visible string

See also

name()