QgsPaintEffectAbstractMetadata class
Stores metadata about a paint effect class.
Contents
Derived classes
- class QgsPaintEffectMetadata
- Convenience metadata class that uses static functions to create an effect and its widget.
Constructors, destructors, conversion operators
- QgsPaintEffectAbstractMetadata(const QString& name, const QString& visibleName)
- Construct a new QgsPaintEffectAbstractMetadata.
Public functions
- auto createPaintEffect(const QgsStringMap& map) -> QgsPaintEffect* pure virtual
- Create a paint effect of this class given an encoded map of properties.
- auto createWidget() -> QgsPaintEffectWidget* virtual
- Create configuration widget for paint effect of this class.
- auto name() const -> QString
- Returns the unique string representing the paint effect class.
- auto visibleName() const -> QString
- Returns the user visible string representing the paint effect class.
Function documentation
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 |
QgsPaintEffect* QgsPaintEffectAbstractMetadata:: createPaintEffect(const QgsStringMap& 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 |
QgsPaintEffectWidget* QgsPaintEffectAbstractMetadata:: createWidget() virtual
Create configuration widget for paint effect of this class.
| Returns | configuration widget |
|---|
Can return nullptr if there's no GUI for the paint effect class.
QString QgsPaintEffectAbstractMetadata:: name() const
Returns the unique string representing the paint effect class.
| Returns | unique string |
|---|
QString QgsPaintEffectAbstractMetadata:: visibleName() const
Returns the user visible string representing the paint effect class.
| Returns | friendly user visible string |
|---|