QGIS API Documentation 3.41.0-Master (cea29feecf2)
|
Stores metadata about one renderer class. More...
#include <qgsrendererregistry.h>
Public Types | |
enum | LayerType { PointLayer = 1 , LineLayer = 2 , PolygonLayer = 4 , All = PointLayer | LineLayer | PolygonLayer } |
Layer types the renderer is compatible with. More... | |
typedef QFlags< LayerType > | LayerTypes |
Public Member Functions | |
QgsRendererAbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon()) | |
Constructor for QgsRendererAbstractMetadata, with the specified name. | |
virtual | ~QgsRendererAbstractMetadata ()=default |
virtual QgsRendererAbstractMetadata::LayerTypes | compatibleLayerTypes () const |
Returns flags indicating the types of layer the renderer is compatible with. | |
virtual QgsFeatureRenderer * | createRenderer (QDomElement &elem, const QgsReadWriteContext &context)=0 |
Returns new instance of the renderer given the DOM element. | |
virtual QgsFeatureRenderer * | createRendererFromSld (QDomElement &elem, Qgis::GeometryType geomType) |
Returns a new instance of the renderer, converted from an SLD XML element. | |
virtual QgsRendererWidget * | createRendererWidget (QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *oldRenderer) |
Returns new instance of settings widget for the renderer. | |
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 | |
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) | |
Stores metadata about one renderer class.
Definition at line 41 of file qgsrendererregistry.h.
typedef QFlags< LayerType > QgsRendererAbstractMetadata::LayerTypes |
Definition at line 55 of file qgsrendererregistry.h.
Layer types the renderer is compatible with.
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.
|
inline |
Constructor for QgsRendererAbstractMetadata, with the specified name.
The visibleName argument gives a translated, user friendly string identifying the renderer type.
The icon argument can be used to specify an icon representing the renderer.
Definition at line 64 of file qgsrendererregistry.h.
|
virtualdefault |
|
inlinevirtual |
Returns flags indicating the types of layer the renderer is compatible with.
Reimplemented in QgsRendererMetadata.
Definition at line 98 of file qgsrendererregistry.h.
|
pure virtual |
Returns new instance of the renderer given the DOM element.
Returns nullptr
on error. Pure virtual function: must be implemented in derived classes.
Implemented in QgsRendererMetadata.
|
inlinevirtual |
Returns a new instance of the renderer, converted from an SLD XML element.
Reimplemented in QgsRendererMetadata.
Definition at line 119 of file qgsrendererregistry.h.
|
inlinevirtual |
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 in QgsRendererMetadata.
Definition at line 113 of file qgsrendererregistry.h.
|
inline |
Returns an icon representing the renderer.
Definition at line 87 of file qgsrendererregistry.h.
|
inline |
Returns the unique name of the renderer.
This value is not translated.
Definition at line 75 of file qgsrendererregistry.h.
|
inline |
Sets an icon representing the renderer.
Definition at line 93 of file qgsrendererregistry.h.
|
inline |
Returns a friendly display name of the renderer.
This value is translated.
Definition at line 81 of file qgsrendererregistry.h.
|
protected |
icon to be shown in the renderer properties dialog
Definition at line 128 of file qgsrendererregistry.h.
|
protected |
name used within QGIS for identification (the same what renderer's type() returns)
Definition at line 124 of file qgsrendererregistry.h.
|
protected |
name visible for users (translatable)
Definition at line 126 of file qgsrendererregistry.h.