QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Protected Attributes | List of all members
QgsPaintEffectMetadata Class Reference

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

#include <qgspainteffectregistry.h>

Inheritance diagram for QgsPaintEffectMetadata:
Inheritance graph
[legend]

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...
 
virtual QgsPaintEffectcreatePaintEffect (const QgsStringMap &map) override
 Creates a new paint effect of the metadata's effect class. More...
 
virtual QgsPaintEffectWidgetcreateWidget () 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...
 

Protected Attributes

QgsPaintEffectCreateFunc mCreateFunc
 
QgsPaintEffectWidgetFunc mWidgetFunc
 

Detailed Description

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

Note
Added in version 2.9

Definition at line 87 of file qgspainteffectregistry.h.

Constructor & Destructor Documentation

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

Create effect metadata from static functions.

Parameters
nameunique string representing paint effect class
visibleNameuser visible name representing paint effect class
pfCreatepaint effect creation function
pfWidgetwidget creation function
Note
not available in python bindings

Definition at line 99 of file qgspainteffectregistry.h.

Member Function Documentation

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 111 of file qgspainteffectregistry.h.

virtual QgsPaintEffect* QgsPaintEffectMetadata::createPaintEffect ( const QgsStringMap map)
inlineoverridevirtual

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

Parameters
mapstring map of effect properties
Returns
new paint effect
Note
not available in python bindings
See also
createWidget

Implements QgsPaintEffectAbstractMetadata.

Definition at line 133 of file qgspainteffectregistry.h.

virtual 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 140 of file qgspainteffectregistry.h.

void QgsPaintEffectMetadata::setWidgetFunction ( QgsPaintEffectWidgetFunc  f)
inline

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

Parameters
fwidget creation function
Note
not available in python bindings
See also
widgetFunction

Definition at line 125 of file qgspainteffectregistry.h.

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 118 of file qgspainteffectregistry.h.

Member Data Documentation

QgsPaintEffectCreateFunc QgsPaintEffectMetadata::mCreateFunc
protected

Definition at line 143 of file qgspainteffectregistry.h.

QgsPaintEffectWidgetFunc QgsPaintEffectMetadata::mWidgetFunc
protected

Definition at line 144 of file qgspainteffectregistry.h.


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