QgsPaintEffectRegistry Class Reference

Singleton registry of available paint effects. More...

#include <qgspainteffectregistry.h>

Public Member Functions
bool	addEffectType (QgsPaintEffectAbstractMetadata *metadata)
	Registers a new effect type. More...
QgsPaintEffect *	createEffect (const QString &name, const QgsStringMap &properties=QgsStringMap()) const
	Creates a new paint effect given the effect name and properties map. More...
QgsPaintEffect *	createEffect (const QDomElement &element) const
	Creates a new paint effect given a DOM element storing paint effect properties. More...
QgsPaintEffectAbstractMetadata *	effectMetadata (const QString &name) const
	Returns the metadata for a specific effect. More...
QStringList	effects () const
	Returns a list of known paint effects. More...

Static Public Member Functions
static QgsPaintEffect *	defaultStack ()
	Returns a new effect stack consisting of a sensible selection of default effects. More...
static QgsPaintEffectRegistry *	instance ()
	Returns a reference to the singleton instance of the paint effect registry. More...
static bool	isDefaultStack (QgsPaintEffect *effect)
	Tests whether a paint effect matches the default effects stack. More...

Protected Member Functions
	QgsPaintEffectRegistry ()
	~QgsPaintEffectRegistry ()

Protected Attributes
QMap< QString, QgsPaintEffectAbstractMetadata * >	mMetadata

Detailed Description

Singleton registry of available paint effects.

Note

Added in version 2.9

Definition at line 154 of file qgspainteffectregistry.h.

Constructor & Destructor Documentation

QgsPaintEffectRegistry()

QgsPaintEffectRegistry::QgsPaintEffectRegistry ( )

protected

Definition at line 31 of file qgspainteffectregistry.cpp.

~QgsPaintEffectRegistry()

QgsPaintEffectRegistry::~QgsPaintEffectRegistry ( )

protected

Definition at line 54 of file qgspainteffectregistry.cpp.

Member Function Documentation

addEffectType()

bool QgsPaintEffectRegistry::addEffectType

(

QgsPaintEffectAbstractMetadata *

metadata

)

Registers a new effect type.

Parameters

metadata

effect metadata. Ownership is transferred to the registry.

Returns

true if add was successful.

Definition at line 73 of file qgspainteffectregistry.cpp.

createEffect() [1/2]

QgsPaintEffect * QgsPaintEffectRegistry::createEffect	(	const QString &	name,
		const QgsStringMap &	properties = QgsStringMap()
	)		const

Creates a new paint effect given the effect name and properties map.

Parameters

name	unique name representing paint effect class
properties	encoded string map of effect properties

Returns

new paint effect of specified class, or nullptr if matching paint effect could not be created

Definition at line 82 of file qgspainteffectregistry.cpp.

createEffect() [2/2]

QgsPaintEffect * QgsPaintEffectRegistry::createEffect

(

const QDomElement &

element

)

const

Creates a new paint effect given a DOM element storing paint effect properties.

Parameters

element

encoded DOM element of effect properties

Returns

new paint effect, or nullptr if matching paint effect could not be created

Definition at line 91 of file qgspainteffectregistry.cpp.

defaultStack()

QgsPaintEffect * QgsPaintEffectRegistry::defaultStack ( )

static

Returns a new effect stack consisting of a sensible selection of default effects.

All effects except the standard draw source effect are disabled, but are included so that they can be easily drawn just by enabling the effect.

Returns

default effects stack

See also

isDefaultStack()

Definition at line 119 of file qgspainteffectregistry.cpp.

effectMetadata()

QgsPaintEffectAbstractMetadata * QgsPaintEffectRegistry::effectMetadata

(

const QString &

name

)

const

Returns the metadata for a specific effect.

Parameters

name	unique string name for paint effect class

Returns

paint effect metadata if found, otherwise nullptr

Definition at line 65 of file qgspainteffectregistry.cpp.

effects()

QStringList QgsPaintEffectRegistry::effects

(

)

const

Returns a list of known paint effects.

Returns

list of paint effect names

Definition at line 108 of file qgspainteffectregistry.cpp.

instance()

QgsPaintEffectRegistry * QgsPaintEffectRegistry::instance ( )

static

Returns a reference to the singleton instance of the paint effect registry.

Definition at line 59 of file qgspainteffectregistry.cpp.

isDefaultStack()

bool QgsPaintEffectRegistry::isDefaultStack ( QgsPaintEffect *  effect )

static

Tests whether a paint effect matches the default effects stack.

Parameters

effect

paint effect to test

Returns

true if effect is default stack

Note

added in QGIS 2.12

See also

defaultStack()

Definition at line 139 of file qgspainteffectregistry.cpp.

Member Data Documentation

mMetadata

QMap<QString, QgsPaintEffectAbstractMetadata*> QgsPaintEffectRegistry::mMetadata

protected

Definition at line 215 of file qgspainteffectregistry.h.

---

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

• /tmp/buildd/qgis-2.18.21+99unstable/src/core/effects/qgspainteffectregistry.h
• /tmp/buildd/qgis-2.18.21+99unstable/src/core/effects/qgspainteffectregistry.cpp