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

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

#include <qgspainteffectregistry.h>

Inheritance diagram for QgsPaintEffectAbstractMetadata:
Inheritance graph
[legend]

Public Member Functions

 QgsPaintEffectAbstractMetadata (const QString &name, const QString &visibleName)
 Construct a new QgsPaintEffectAbstractMetadata. More...
 
virtual ~QgsPaintEffectAbstractMetadata ()
 
virtual QgsPaintEffectcreatePaintEffect (const QgsStringMap &map)=0
 Create a paint effect of this class given an encoded map of properties. More...
 
virtual QgsPaintEffectWidgetcreateWidget ()
 Create configuration widget for paint effect of this class. More...
 
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

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.
Added in version 2.9

Definition at line 36 of file qgspainteffectregistry.h.

Constructor & Destructor Documentation

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

Construct a new QgsPaintEffectAbstractMetadata.

Parameters
nameunique string representing paint effect class
visibleNameuser visible name representing paint effect class

Definition at line 24 of file qgspainteffectregistry.cpp.

virtual QgsPaintEffectAbstractMetadata::~QgsPaintEffectAbstractMetadata ( )
inlinevirtual

Definition at line 46 of file qgspainteffectregistry.h.

Member Function Documentation

virtual QgsPaintEffect* QgsPaintEffectAbstractMetadata::createPaintEffect ( const QgsStringMap map)
pure virtual

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

Parameters
mapproperties string map
Returns
new paint effect

Implemented in QgsPaintEffectMetadata.

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

QString QgsPaintEffectAbstractMetadata::name ( ) const
inline

Returns the unique string representing the paint effect class.

Returns
unique string
See also
visibleName

Definition at line 52 of file qgspainteffectregistry.h.

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

Member Data Documentation

QString QgsPaintEffectAbstractMetadata::mName
protected

Definition at line 73 of file qgspainteffectregistry.h.

QString QgsPaintEffectAbstractMetadata::mVisibleName
protected

Definition at line 74 of file qgspainteffectregistry.h.


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