Class: QgsPaintEffectAbstractMetadata¶
- class qgis.core.QgsPaintEffectAbstractMetadata¶
Bases:
sip.wrapper
Stores metadata about a paint effect class.
Note
It’s necessary to implement the
createPaintEffect()
function. In C++ you can use theQgsPaintEffectMetadata
convenience class to simplify creation of the metadata.New in version 2.9.
QgsPaintEffectAbstractMetadata(name: str, visibleName: str) Construct a new QgsPaintEffectAbstractMetadata
- Parameters:
name – unique string representing paint effect class
visibleName – user visible name representing paint effect class
QgsPaintEffectAbstractMetadata(
QgsPaintEffectAbstractMetadata
)Methods
Create a paint effect of this class given an encoded map of properties.
Create configuration widget for paint effect of this class.
Returns the unique string representing the paint effect class
Returns the user visible string representing the paint effect class
- createPaintEffect(self, map: Dict[str, Any]) QgsPaintEffect ¶
Create a paint effect of this class given an encoded map of properties.
- Parameters:
map (Dict[str) – properties string map
- Return type:
- Returns:
new paint effect
- createWidget(self) QgsPaintEffectWidget ¶
Create configuration widget for paint effect of this class. Can return
None
if there’s no GUI for the paint effect class.- Return type:
- Returns:
configuration widget
- name(self) str ¶
Returns the unique string representing the paint effect class
- Return type:
str
- Returns:
unique string
See also