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

#include <qgspainteffectregistry.h>

Inheritance diagram for QgsPaintEffectMetadata:

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

QgsPaintEffectCreateFunc	createFunction () const
	Returns the paint effect creation function for the paint effect class. More...

QgsPaintEffect *	createPaintEffect (const QgsStringMap &map) override
	Creates a new paint effect of the metadata's effect class. More...

QgsPaintEffectWidget *	createWidget () override
	Creates a new paint effect properties widget for the metadata's effect class. More...

void	setWidgetFunction (QgsPaintEffectWidgetFunc f)
	Sets the paint effect properties widget creation function for the paint effect class. More...

QgsPaintEffectWidgetFunc	widgetFunction () const
	Returns the paint effect properties widget creation function for the paint effect class. More...

Public Member Functions inherited from QgsPaintEffectAbstractMetadata
	QgsPaintEffectAbstractMetadata (const QString &name, const QString &visibleName)
	Construct a new QgsPaintEffectAbstractMetadata. More...

virtual	~QgsPaintEffectAbstractMetadata ()=default

QString	name () const
	Returns the unique string representing the paint effect class. More...

QString	visibleName () const
	Returns the user visible string representing the paint effect class. More...

Protected Attributes
QgsPaintEffectCreateFunc	mCreateFunc

QgsPaintEffectWidgetFunc	mWidgetFunc

Protected Attributes inherited from QgsPaintEffectAbstractMetadata
QString	mName

QString	mVisibleName

Detailed Description

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

Note: not available in Python bindings

Since: QGIS 2.9

Definition at line 97 of file qgspainteffectregistry.h.

Constructor & Destructor Documentation

◆ QgsPaintEffectMetadata()

QgsPaintEffectMetadata::QgsPaintEffectMetadata	(	const QString &	name,
		const QString &	visibleName,
		QgsPaintEffectCreateFunc	pfCreate,
		QgsPaintEffectWidgetFunc	pfWidget = `nullptr`
	)

inline

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

Note: not available in Python bindings

Definition at line 110 of file qgspainteffectregistry.h.

Member Function Documentation

◆ createFunction()

QgsPaintEffectCreateFunc QgsPaintEffectMetadata::createFunction ( ) const

inline

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

Returns: creation function

Note: not available in Python bindings

Definition at line 123 of file qgspainteffectregistry.h.

◆ createPaintEffect()

QgsPaintEffect* QgsPaintEffectMetadata::createPaintEffect ( const QgsStringMap & map )

inlineoverridevirtual

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

Parameters

map	string map of effect properties

Returns: new paint effect

Note: not available in Python bindings

See also: createWidget

Implements QgsPaintEffectAbstractMetadata.

Definition at line 148 of file qgspainteffectregistry.h.

◆ createWidget()

QgsPaintEffectWidget* QgsPaintEffectMetadata::createWidget ( )

inlineoverridevirtual

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

Returns: effect properties widget

Note: not available in Python bindings

See also: createWidget

Reimplemented from QgsPaintEffectAbstractMetadata.

Definition at line 156 of file qgspainteffectregistry.h.

◆ setWidgetFunction()

void QgsPaintEffectMetadata::setWidgetFunction ( QgsPaintEffectWidgetFunc f )

inline

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

Parameters

f	widget creation function

Note: not available in Python bindings

See also: widgetFunction

Definition at line 139 of file qgspainteffectregistry.h.

◆ widgetFunction()

QgsPaintEffectWidgetFunc QgsPaintEffectMetadata::widgetFunction ( ) const

inline

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

Returns: widget creation function

Note: not available in Python bindings

See also: setWidgetFunction

Definition at line 131 of file qgspainteffectregistry.h.

Member Data Documentation

◆ mCreateFunc

QgsPaintEffectCreateFunc QgsPaintEffectMetadata::mCreateFunc

protected

Definition at line 159 of file qgspainteffectregistry.h.

◆ mWidgetFunc

QgsPaintEffectWidgetFunc QgsPaintEffectMetadata::mWidgetFunc

protected

Definition at line 160 of file qgspainteffectregistry.h.

The documentation for this class was generated from the following file:

/build/qgis-3.14.0+99unstable/src/core/effects/qgspainteffectregistry.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsPaintEffectMetadata()

Member Function Documentation

◆ createFunction()

◆ createPaintEffect()

◆ createWidget()

◆ setWidgetFunction()

◆ widgetFunction()

Member Data Documentation

◆ mCreateFunc

◆ mWidgetFunc