QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
Convenience metadata class that uses static functions to create renderer and its widget. More...
#include <qgsrendererregistry.h>
Public Member Functions | |
QgsRendererMetadata (const QString &name, const QString &visibleName, QgsRendererCreateFunc pfCreate, const QIcon &icon=QIcon(), QgsRendererWidgetFunc pfWidget=nullptr, QgsRendererAbstractMetadata::LayerTypes layerTypes=QgsRendererAbstractMetadata::All) | |
Construct metadata. More... | |
QgsRendererMetadata (const QString &name, const QString &visibleName, QgsRendererCreateFunc pfCreate, QgsRendererCreateFromSldFunc pfCreateFromSld, const QIcon &icon=QIcon(), QgsRendererWidgetFunc pfWidget=nullptr, QgsRendererAbstractMetadata::LayerTypes layerTypes=QgsRendererAbstractMetadata::All) | |
QgsRendererAbstractMetadata::LayerTypes | compatibleLayerTypes () const override |
Returns flags indicating the types of layer the renderer is compatible with. More... | |
QgsRendererCreateFromSldFunc | createFromSldFunction () const |
QgsRendererCreateFunc | createFunction () const |
QgsFeatureRenderer * | createRenderer (QDomElement &elem, const QgsReadWriteContext &context) override |
Returns new instance of the renderer given the DOM element. More... | |
QgsFeatureRenderer * | createRendererFromSld (QDomElement &elem, QgsWkbTypes::GeometryType geomType) override |
QgsRendererWidget * | createRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer) override |
Returns new instance of settings widget for the renderer. More... | |
void | setWidgetFunction (QgsRendererWidgetFunc f) |
QgsRendererWidgetFunc | widgetFunction () const |
![]() | |
QgsRendererAbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon()) | |
Constructor for QgsRendererAbstractMetadata, with the specified name. More... | |
virtual | ~QgsRendererAbstractMetadata ()=default |
QIcon | icon () const |
Returns an icon representing the renderer. More... | |
QString | name () const |
Returns the unique name of the renderer. More... | |
void | setIcon (const QIcon &icon) |
Sets an icon representing the renderer. More... | |
QString | visibleName () const |
Returns a friendly display name of the renderer. More... | |
Protected Attributes | |
QgsRendererCreateFromSldFunc | mCreateFromSldFunc |
pointer to function that creates an instance of the renderer from SLD More... | |
QgsRendererCreateFunc | mCreateFunc |
pointer to function that creates an instance of the renderer when loading project / style More... | |
QgsRendererWidgetFunc | mWidgetFunc |
pointer to function that creates a widget for configuration of renderer's params More... | |
![]() | |
QIcon | mIcon |
icon to be shown in the renderer properties dialog More... | |
QString | mName |
name used within QGIS for identification (the same what renderer's type() returns) More... | |
QString | mVisibleName |
name visible for users (translatable) More... | |
Additional Inherited Members | |
![]() | |
enum | LayerType { PointLayer = 1 , LineLayer = 2 , PolygonLayer = 4 , All = PointLayer | LineLayer | PolygonLayer } |
Layer types the renderer is compatible with. More... | |
Convenience metadata class that uses static functions to create renderer and its widget.
Definition at line 142 of file qgsrendererregistry.h.
|
inline |
Construct metadata.
Definition at line 150 of file qgsrendererregistry.h.
|
inline |
Definition at line 164 of file qgsrendererregistry.h.
|
inlineoverridevirtual |
Returns flags indicating the types of layer the renderer is compatible with.
Reimplemented from QgsRendererAbstractMetadata.
Definition at line 195 of file qgsrendererregistry.h.
|
inline |
Definition at line 190 of file qgsrendererregistry.h.
|
inline |
Definition at line 186 of file qgsrendererregistry.h.
|
inlineoverridevirtual |
Returns new instance of the renderer given the DOM element.
Returns nullptr
on error. Pure virtual function: must be implemented in derived classes.
Implements QgsRendererAbstractMetadata.
Definition at line 178 of file qgsrendererregistry.h.
|
inlineoverridevirtual |
Reimplemented from QgsRendererAbstractMetadata.
Definition at line 182 of file qgsrendererregistry.h.
|
inlineoverridevirtual |
Returns new instance of settings widget for the renderer.
Returns nullptr
on error.
The oldRenderer argument may refer to previously used renderer (or it is nullptr
). If not nullptr
, it may be used to initialize GUI of the widget from the previous settings. The old renderer does not have to be of the same type as returned by createRenderer().
Reimplemented from QgsRendererAbstractMetadata.
Definition at line 180 of file qgsrendererregistry.h.
|
inline |
Definition at line 193 of file qgsrendererregistry.h.
|
inline |
Definition at line 188 of file qgsrendererregistry.h.
|
protected |
pointer to function that creates an instance of the renderer from SLD
Definition at line 203 of file qgsrendererregistry.h.
|
protected |
pointer to function that creates an instance of the renderer when loading project / style
Definition at line 199 of file qgsrendererregistry.h.
|
protected |
pointer to function that creates a widget for configuration of renderer's params
Definition at line 201 of file qgsrendererregistry.h.