QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Attributes | List of all members
QgsRendererV2Metadata Class Reference

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

#include <qgsrendererv2registry.h>

Inheritance diagram for QgsRendererV2Metadata:
Inheritance graph
[legend]

Public Member Functions

 QgsRendererV2Metadata (QString name, QString visibleName, QgsRendererV2CreateFunc pfCreate, QIcon icon=QIcon(), QgsRendererV2WidgetFunc pfWidget=NULL)
 construct metadata More...
 
 QgsRendererV2Metadata (QString name, QString visibleName, QgsRendererV2CreateFunc pfCreate, QgsRendererV2CreateFromSldFunc pfCreateFromSld, QIcon icon=QIcon(), QgsRendererV2WidgetFunc pfWidget=NULL)
 
virtual ~QgsRendererV2Metadata ()
 
virtual QgsFeatureRendererV2createRenderer (QDomElement &elem)
 Return new instance of the renderer given the DOM element. More...
 
virtual QgsRendererV2WidgetcreateRendererWidget (QgsVectorLayer *layer, QgsStyleV2 *style, QgsFeatureRendererV2 *renderer)
 Return new instance of settings widget for the renderer. More...
 
virtual QgsFeatureRendererV2createRendererFromSld (QDomElement &elem, QGis::GeometryType geomType)
 
QgsRendererV2CreateFunc createFunction () const
 
QgsRendererV2WidgetFunc widgetFunction () const
 
QgsRendererV2CreateFromSldFunc createFromSldFunction () const
 
void setWidgetFunction (QgsRendererV2WidgetFunc f)
 

Protected Attributes

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...
 
QgsRendererV2CreateFromSldFunc mCreateFromSldFunc
 pointer to function that creates an instance of the renderer from SLD More...
 

Detailed Description

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

Constructor & Destructor Documentation

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

construct metadata

Note
not available in python bindings
QgsRendererV2Metadata::QgsRendererV2Metadata ( QString  name,
QString  visibleName,
QgsRendererV2CreateFunc  pfCreate,
QgsRendererV2CreateFromSldFunc  pfCreateFromSld,
QIcon  icon = QIcon(),
QgsRendererV2WidgetFunc  pfWidget = NULL 
)
inline
Note
not available in python bindings
QgsRendererV2Metadata::~QgsRendererV2Metadata ( )
virtual

Member Function Documentation

QgsRendererV2CreateFromSldFunc QgsRendererV2Metadata::createFromSldFunction ( ) const
inline
Note
not available in python bindings
QgsRendererV2CreateFunc QgsRendererV2Metadata::createFunction ( ) const
inline
Note
not available in python bindings
virtual QgsFeatureRendererV2* QgsRendererV2Metadata::createRenderer ( QDomElement &  elem)
inlinevirtual

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.

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

Reimplemented from QgsRendererV2AbstractMetadata.

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

Return new instance of settings widget for the renderer.

Returns NULL on error.

Reimplemented from QgsRendererV2AbstractMetadata.

void QgsRendererV2Metadata::setWidgetFunction ( QgsRendererV2WidgetFunc  f)
inline
Note
not available in python bindings
QgsRendererV2WidgetFunc QgsRendererV2Metadata::widgetFunction ( ) const
inline
Note
not available in python bindings

Member Data Documentation

QgsRendererV2CreateFromSldFunc QgsRendererV2Metadata::mCreateFromSldFunc
protected

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

QgsRendererV2CreateFunc QgsRendererV2Metadata::mCreateFunc
protected

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

QgsRendererV2WidgetFunc QgsRendererV2Metadata::mWidgetFunc
protected

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


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