Stores metadata about a paint effect class. More...

#include <qgspainteffectregistry.h>

Inheritance diagram for QgsPaintEffectAbstractMetadata:

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

virtual	~QgsPaintEffectAbstractMetadata ()=default

virtual QgsPaintEffect *	createPaintEffect (const QVariantMap &map)=0
	Create a paint effect of this class given an encoded map of properties.

virtual QgsPaintEffectWidget *	createWidget ()
	Create configuration widget for paint effect of this class.

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

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

Protected Attributes
QString	mName

QString	mVisibleName

Detailed Description

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.

Definition at line 39 of file qgspainteffectregistry.h.

Constructor & Destructor Documentation

◆ QgsPaintEffectAbstractMetadata()

QgsPaintEffectAbstractMetadata::QgsPaintEffectAbstractMetadata	(	const QString &	name,
		const QString &	visibleName
	)

Construct a new QgsPaintEffectAbstractMetadata.

Parameters

name	unique string representing paint effect class
visibleName	user visible name representing paint effect class

Definition at line 25 of file qgspainteffectregistry.cpp.

◆ ~QgsPaintEffectAbstractMetadata()

virtual QgsPaintEffectAbstractMetadata::~QgsPaintEffectAbstractMetadata ( )

virtualdefault

Member Function Documentation

◆ createPaintEffect()

virtual QgsPaintEffect * QgsPaintEffectAbstractMetadata::createPaintEffect ( const QVariantMap & map )

pure virtual

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

Parameters

map	properties string map

Returns: new paint effect

Implemented in QgsPaintEffectMetadata.

◆ createWidget()

virtual QgsPaintEffectWidget * QgsPaintEffectAbstractMetadata::createWidget ( )

inlinevirtual

Create configuration widget for paint effect of this class.

Can return nullptr if there's no GUI for the paint effect class.

Returns: configuration widget

Reimplemented in QgsPaintEffectMetadata.

Definition at line 78 of file qgspainteffectregistry.h.

◆ name()

QString QgsPaintEffectAbstractMetadata::name ( ) const

inline

Returns the unique string representing the paint effect class.

Returns: unique string

See also: visibleName

Definition at line 57 of file qgspainteffectregistry.h.

◆ visibleName()

QString QgsPaintEffectAbstractMetadata::visibleName ( ) const

inline

Returns the user visible string representing the paint effect class.

Returns: friendly user visible string

See also: name

Definition at line 64 of file qgspainteffectregistry.h.

Member Data Documentation

◆ mName

QString QgsPaintEffectAbstractMetadata::mName

protected

Definition at line 81 of file qgspainteffectregistry.h.

◆ mVisibleName

QString QgsPaintEffectAbstractMetadata::mVisibleName