QGIS API Documentation  3.13.0-Master (13337b20cd)
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 ()=default
 
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.
Since
QGIS 2.9

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
nameunique string representing paint effect class
visibleNameuser 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 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.

◆ 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
protected

Definition at line 82 of file qgspainteffectregistry.h.


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