QgsPaintEffectMetadata class

Convenience metadata class that uses static functions to create an effect and its widget.

Base classes

class QgsPaintEffectAbstractMetadata: Stores metadata about a paint effect class.

QgsPaintEffectMetadata(const QString& name, const QString& visibleName, QgsPaintEffectCreateFunc pfCreate, QgsPaintEffectWidgetFunc pfWidget = nullptr): Create effect metadata from static functions.

auto createFunction() const -> QgsPaintEffectCreateFunc: Returns the paint effect creation function for the paint effect class.
auto createPaintEffect(const QgsStringMap& map) -> QgsPaintEffect* override: Creates a new paint effect of the metadata's effect class.
auto createWidget() -> QgsPaintEffectWidget* override: Creates a new paint effect properties widget for the metadata's effect class.
void setWidgetFunction(QgsPaintEffectWidgetFunc f): Sets the paint effect properties widget creation function for the paint effect class.
auto widgetFunction() const -> QgsPaintEffectWidgetFunc: Returns the paint effect properties widget creation function for the paint effect class.

Create effect metadata from static functions.

Parameters
name	unique string representing paint effect class
visibleName	user visible name representing paint effect class
pfCreate	paint effect creation function
pfWidget	widget creation function

Returns the paint effect creation function for the paint effect class.

Returns	creation function

Creates a new paint effect of the metadata's effect class.

Parameters
map	string map of effect properties
Returns	new paint effect

Creates a new paint effect properties widget for the metadata's effect class.

Returns	effect properties widget

Sets the paint effect properties widget creation function for the paint effect class.

Parameters
f	widget creation function

Returns the paint effect properties widget creation function for the paint effect class.

Returns	widget creation function