QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
QgsRendererMetadata Class Reference
core library

Convenience metadata class that uses static functions to create renderer and its widget. More...

#include <qgsrendererregistry.h>

Inheritance diagram for QgsRendererMetadata:
Inheritance graph
[legend]

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.
 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.
QgsRendererCreateFromSldFunc createFromSldFunction () const
QgsRendererCreateFunc createFunction () const
QgsFeatureRenderer * createRenderer (QDomElement &elem, const QgsReadWriteContext &context) override
 Returns new instance of the renderer given the DOM element.
QgsFeatureRenderer * createRendererFromSld (QDomElement &elem, Qgis::GeometryType geomType) override
 Returns a new instance of the renderer, converted from an SLD XML element.
QgsRendererWidget * createRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer) override
 Returns new instance of settings widget for the renderer.
void setWidgetFunction (QgsRendererWidgetFunc f)
QgsRendererWidgetFunc widgetFunction () const
Public Member Functions inherited from QgsRendererAbstractMetadata
 QgsRendererAbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon())
 Constructor for QgsRendererAbstractMetadata, with the specified name.
virtual ~QgsRendererAbstractMetadata ()=default
QIcon icon () const
 Returns an icon representing the renderer.
QString name () const
 Returns the unique name of the renderer.
void setIcon (const QIcon &icon)
 Sets an icon representing the renderer.
QString visibleName () const
 Returns a friendly display name of the renderer.

Protected Attributes

QgsRendererCreateFromSldFunc mCreateFromSldFunc
 pointer to function that creates an instance of the renderer from SLD
QgsRendererCreateFunc mCreateFunc
 pointer to function that creates an instance of the renderer when loading project / style
QgsRendererWidgetFunc mWidgetFunc
 pointer to function that creates a widget for configuration of renderer's params
Protected Attributes inherited from QgsRendererAbstractMetadata
QIcon mIcon
 icon to be shown in the renderer properties dialog
QString mName
 name used within QGIS for identification (the same what renderer's type() returns)
QString mVisibleName
 name visible for users (translatable)

Additional Inherited Members

Public Types inherited from QgsRendererAbstractMetadata
enum  LayerType { PointLayer = 1 , LineLayer = 2 , PolygonLayer = 4 , All = PointLayer | LineLayer | PolygonLayer }
 Layer types the renderer is compatible with. More...
typedef QFlags< LayerType > LayerTypes

Detailed Description

Convenience metadata class that uses static functions to create renderer and its widget.

Definition at line 144 of file qgsrendererregistry.h.

Constructor & Destructor Documentation

◆ QgsRendererMetadata() [1/2]

QgsRendererMetadata::QgsRendererMetadata ( const QString & name,
const QString & visibleName,
QgsRendererCreateFunc pfCreate,
const QIcon & icon = QIcon(),
QgsRendererWidgetFunc pfWidget = nullptr,
QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All )
inline

Construct metadata.

Note
not available in Python bindings

Definition at line 152 of file qgsrendererregistry.h.

◆ QgsRendererMetadata() [2/2]

QgsRendererMetadata::QgsRendererMetadata ( const QString & name,
const QString & visibleName,
QgsRendererCreateFunc pfCreate,
QgsRendererCreateFromSldFunc pfCreateFromSld,
const QIcon & icon = QIcon(),
QgsRendererWidgetFunc pfWidget = nullptr,
QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All )
inline
Note
not available in Python bindings

Definition at line 166 of file qgsrendererregistry.h.

Member Function Documentation

◆ compatibleLayerTypes()

QgsRendererAbstractMetadata::LayerTypes QgsRendererMetadata::compatibleLayerTypes ( ) const
inlineoverridevirtual

Returns flags indicating the types of layer the renderer is compatible with.

Reimplemented from QgsRendererAbstractMetadata.

Definition at line 197 of file qgsrendererregistry.h.

◆ createFromSldFunction()

QgsRendererCreateFromSldFunc QgsRendererMetadata::createFromSldFunction ( ) const
inline
Note
not available in Python bindings

Definition at line 192 of file qgsrendererregistry.h.

◆ createFunction()

QgsRendererCreateFunc QgsRendererMetadata::createFunction ( ) const
inline
Note
not available in Python bindings

Definition at line 188 of file qgsrendererregistry.h.

◆ createRenderer()

QgsFeatureRenderer * QgsRendererMetadata::createRenderer ( QDomElement & elem,
const QgsReadWriteContext & context )
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 180 of file qgsrendererregistry.h.

◆ createRendererFromSld()

QgsFeatureRenderer * QgsRendererMetadata::createRendererFromSld ( QDomElement & elem,
Qgis::GeometryType geomType )
inlineoverridevirtual

Returns a new instance of the renderer, converted from an SLD XML element.

Reimplemented from QgsRendererAbstractMetadata.

Definition at line 184 of file qgsrendererregistry.h.

◆ createRendererWidget()

QgsRendererWidget * QgsRendererMetadata::createRendererWidget ( QgsVectorLayer * layer,
QgsStyle * style,
QgsFeatureRenderer * oldRenderer )
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 182 of file qgsrendererregistry.h.

◆ setWidgetFunction()

void QgsRendererMetadata::setWidgetFunction ( QgsRendererWidgetFunc f)
inline
Note
not available in Python bindings

Definition at line 195 of file qgsrendererregistry.h.

◆ widgetFunction()

QgsRendererWidgetFunc QgsRendererMetadata::widgetFunction ( ) const
inline
Note
not available in Python bindings

Definition at line 190 of file qgsrendererregistry.h.

Member Data Documentation

◆ mCreateFromSldFunc

QgsRendererCreateFromSldFunc QgsRendererMetadata::mCreateFromSldFunc
protected

pointer to function that creates an instance of the renderer from SLD

Definition at line 205 of file qgsrendererregistry.h.

◆ mCreateFunc

QgsRendererCreateFunc QgsRendererMetadata::mCreateFunc
protected

pointer to function that creates an instance of the renderer when loading project / style

Definition at line 201 of file qgsrendererregistry.h.

◆ mWidgetFunc

QgsRendererWidgetFunc QgsRendererMetadata::mWidgetFunc
protected

pointer to function that creates a widget for configuration of renderer's params

Definition at line 203 of file qgsrendererregistry.h.

The documentation for this class was generated from the following file:
Generated on for QGIS API Documentation by doxygen 1.15.0