QgsRendererV2Metadata Class Reference

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

#include <qgsrendererv2registry.h>

Inheritance diagram for QgsRendererV2Metadata:

Public Member Functions
	QgsRendererV2Metadata (const QString &name, const QString &visibleName, QgsRendererV2CreateFunc pfCreate, const QIcon &icon=QIcon(), QgsRendererV2WidgetFunc pfWidget=NULL)
	Construct metadata. More...
	QgsRendererV2Metadata (const QString &name, const QString &visibleName, QgsRendererV2CreateFunc pfCreate, QgsRendererV2CreateFromSldFunc pfCreateFromSld, const QIcon &icon=QIcon(), QgsRendererV2WidgetFunc pfWidget=NULL)
virtual	~QgsRendererV2Metadata ()
QgsRendererV2CreateFromSldFunc	createFromSldFunction () const
QgsRendererV2CreateFunc	createFunction () const
virtual QgsFeatureRendererV2 *	createRenderer (QDomElement &elem) override
	Return new instance of the renderer given the DOM element. More...
virtual QgsFeatureRendererV2 *	createRendererFromSld (QDomElement &elem, QGis::GeometryType geomType) override
virtual QgsRendererV2Widget *	createRendererWidget (QgsVectorLayer *layer, QgsStyleV2 *style, QgsFeatureRendererV2 *renderer) override
	Return new instance of settings widget for the renderer. More...
void	setWidgetFunction (QgsRendererV2WidgetFunc f)
QgsRendererV2WidgetFunc	widgetFunction () const
Public Member Functions inherited from QgsRendererV2AbstractMetadata
	QgsRendererV2AbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon())
virtual	~QgsRendererV2AbstractMetadata ()
QIcon	icon () const
QString	name () const
void	setIcon (const QIcon &icon)
QString	visibleName () const

Protected Attributes
QgsRendererV2CreateFromSldFunc	mCreateFromSldFunc
	pointer to function that creates an instance of the renderer from SLD More...
QgsRendererV2CreateFunc	mCreateFunc
	pointer to function that creates an instance of the renderer when loading project / style More...
QgsRendererV2WidgetFunc	mWidgetFunc
	pointer to function that creates a widget for configuration of renderer's params More...
Protected Attributes inherited from QgsRendererV2AbstractMetadata
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...

Detailed Description

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

Definition at line 76 of file qgsrendererv2registry.h.

Constructor & Destructor Documentation

QgsRendererV2Metadata::QgsRendererV2Metadata ( const QString &  name, const QString &  visibleName, QgsRendererV2CreateFunc  pfCreate, const QIcon &  icon = QIcon(), QgsRendererV2WidgetFunc  pfWidget = NULL  )

inline

Construct metadata.

Note

not available in python bindings

Definition at line 82 of file qgsrendererv2registry.h.

QgsRendererV2Metadata::QgsRendererV2Metadata ( const QString &  name, const QString &  visibleName, QgsRendererV2CreateFunc  pfCreate, QgsRendererV2CreateFromSldFunc  pfCreateFromSld, const QIcon &  icon = QIcon(), QgsRendererV2WidgetFunc  pfWidget = NULL  )

inline

Note

not available in python bindings

Definition at line 94 of file qgsrendererv2registry.h.

QgsRendererV2Metadata::~QgsRendererV2Metadata ( )

virtual

Definition at line 102 of file qgsrendererv2registry.cpp.

Member Function Documentation

QgsRendererV2CreateFromSldFunc QgsRendererV2Metadata::createFromSldFunction ( ) const

inline

Note

not available in python bindings

Definition at line 119 of file qgsrendererv2registry.h.

QgsRendererV2CreateFunc QgsRendererV2Metadata::createFunction ( ) const

inline

Note

not available in python bindings

Definition at line 115 of file qgsrendererv2registry.h.

virtual QgsFeatureRendererV2* QgsRendererV2Metadata::createRenderer ( QDomElement &  elem )

inlineoverridevirtual

Return new instance of the renderer given the DOM element.

Returns NULL on error. Pure virtual function: must be implemented in derived classes.

Implements QgsRendererV2AbstractMetadata.

Definition at line 108 of file qgsrendererv2registry.h.

virtual QgsFeatureRendererV2* QgsRendererV2Metadata::createRendererFromSld ( QDomElement &  elem, QGis::GeometryType  geomType  )

inlineoverridevirtual

Reimplemented from QgsRendererV2AbstractMetadata.

Definition at line 111 of file qgsrendererv2registry.h.

virtual QgsRendererV2Widget* QgsRendererV2Metadata::createRendererWidget ( QgsVectorLayer *  layer, QgsStyleV2 *  style, QgsFeatureRendererV2 *  renderer  )

inlineoverridevirtual

Return new instance of settings widget for the renderer.

Returns NULL on error.

Reimplemented from QgsRendererV2AbstractMetadata.

Definition at line 109 of file qgsrendererv2registry.h.

void QgsRendererV2Metadata::setWidgetFunction ( QgsRendererV2WidgetFunc  f )

inline

Note

not available in python bindings

Definition at line 122 of file qgsrendererv2registry.h.

QgsRendererV2WidgetFunc QgsRendererV2Metadata::widgetFunction ( ) const

inline

Note

not available in python bindings

Definition at line 117 of file qgsrendererv2registry.h.

Member Data Documentation

QgsRendererV2CreateFromSldFunc QgsRendererV2Metadata::mCreateFromSldFunc

protected

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

Definition at line 130 of file qgsrendererv2registry.h.

QgsRendererV2CreateFunc QgsRendererV2Metadata::mCreateFunc

protected

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

Definition at line 126 of file qgsrendererv2registry.h.

QgsRendererV2WidgetFunc QgsRendererV2Metadata::mWidgetFunc

protected

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

Definition at line 128 of file qgsrendererv2registry.h.

---

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

• /tmp/buildd/qgis-2.12.0+99unstable/src/core/symbology-ng/qgsrendererv2registry.h
• /tmp/buildd/qgis-2.12.0+99unstable/src/core/symbology-ng/qgsrendererv2registry.cpp