QGIS API Documentation  3.1.0-Master (cd495fb)
Public Types | Public Member Functions | Protected Attributes | List of all members
QgsRendererAbstractMetadata Class Referenceabstract

Stores metadata about one renderer class. More...

#include <qgsrendererregistry.h>

Inheritance diagram for QgsRendererAbstractMetadata:
Inheritance graph
[legend]

Public Types

enum  LayerType { PointLayer = 1, LineLayer = 2, PolygonLayer = 4, All = PointLayer | LineLayer | PolygonLayer }
 Layer types the renderer is compatible with. More...
 

Public Member Functions

 QgsRendererAbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon())
 
virtual ~QgsRendererAbstractMetadata ()=default
 
virtual QgsRendererAbstractMetadata::LayerTypes compatibleLayerTypes () const
 Returns flags indicating the types of layer the renderer is compatible with. More...
 
virtual QgsFeatureRenderercreateRenderer (QDomElement &elem, const QgsReadWriteContext &context)=0
 Returns new instance of the renderer given the DOM element. More...
 
virtual QgsFeatureRenderercreateRendererFromSld (QDomElement &elem, QgsWkbTypes::GeometryType geomType)
 
virtual QgsRendererWidgetcreateRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *oldRenderer)
 Returns new instance of settings widget for the renderer. More...
 
QIcon icon () const
 
QString name () const
 
void setIcon (const QIcon &icon)
 
QString visibleName () const
 

Protected Attributes

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

Stores metadata about one renderer class.

Note
It's necessary to implement createRenderer() function. In C++ you can use QgsRendererMetadata convenience class.

Definition at line 40 of file qgsrendererregistry.h.

Member Enumeration Documentation

◆ LayerType

Layer types the renderer is compatible with.

Since
QGIS 2.16
Enumerator
PointLayer 

Compatible with point layers.

LineLayer 

Compatible with line layers.

PolygonLayer 

Compatible with polygon layers.

All 

Compatible with all vector layers.

Definition at line 48 of file qgsrendererregistry.h.

Constructor & Destructor Documentation

◆ QgsRendererAbstractMetadata()

QgsRendererAbstractMetadata::QgsRendererAbstractMetadata ( const QString &  name,
const QString &  visibleName,
const QIcon &  icon = QIcon() 
)
inline

Definition at line 57 of file qgsrendererregistry.h.

◆ ~QgsRendererAbstractMetadata()

virtual QgsRendererAbstractMetadata::~QgsRendererAbstractMetadata ( )
virtualdefault

Member Function Documentation

◆ compatibleLayerTypes()

virtual QgsRendererAbstractMetadata::LayerTypes QgsRendererAbstractMetadata::compatibleLayerTypes ( ) const
inlinevirtual

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

Since
QGIS 2.16

Reimplemented in QgsRendererMetadata.

Definition at line 74 of file qgsrendererregistry.h.

◆ createRenderer()

virtual QgsFeatureRenderer* QgsRendererAbstractMetadata::createRenderer ( QDomElement &  elem,
const QgsReadWriteContext context 
)
pure virtual

Returns new instance of the renderer given the DOM element.

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

Implemented in QgsRendererMetadata.

◆ createRendererFromSld()

virtual QgsFeatureRenderer* QgsRendererAbstractMetadata::createRendererFromSld ( QDomElement &  elem,
QgsWkbTypes::GeometryType  geomType 
)
inlinevirtual

Reimplemented in QgsRendererMetadata.

Definition at line 92 of file qgsrendererregistry.h.

◆ createRendererWidget()

virtual QgsRendererWidget* QgsRendererAbstractMetadata::createRendererWidget ( QgsVectorLayer layer,
QgsStyle style,
QgsFeatureRenderer oldRenderer 
)
inlinevirtual

Returns new instance of settings widget for the renderer.

Returns NULL on error.

The oldRenderer argument may refer to previously used renderer (or it is null). If not null, 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(). When using oldRenderer make sure to make a copy of it - it will be deleted afterwards.

Reimplemented in QgsRendererMetadata.

Definition at line 89 of file qgsrendererregistry.h.

◆ icon()

QIcon QgsRendererAbstractMetadata::icon ( ) const
inline

Definition at line 67 of file qgsrendererregistry.h.

◆ name()

QString QgsRendererAbstractMetadata::name ( ) const
inline

Definition at line 64 of file qgsrendererregistry.h.

◆ setIcon()

void QgsRendererAbstractMetadata::setIcon ( const QIcon &  icon)
inline

Definition at line 68 of file qgsrendererregistry.h.

◆ visibleName()

QString QgsRendererAbstractMetadata::visibleName ( ) const
inline

Definition at line 65 of file qgsrendererregistry.h.

Member Data Documentation

◆ mIcon

QIcon QgsRendererAbstractMetadata::mIcon
protected

icon to be shown in the renderer properties dialog

Definition at line 101 of file qgsrendererregistry.h.

◆ mName

QString QgsRendererAbstractMetadata::mName
protected

name used within QGIS for identification (the same what renderer's type() returns)

Definition at line 97 of file qgsrendererregistry.h.

◆ mVisibleName

QString QgsRendererAbstractMetadata::mVisibleName
protected

name visible for users (translatable)

Definition at line 99 of file qgsrendererregistry.h.


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