Quantum GIS API Documentation  1.8
Public Member Functions | Protected Attributes
QgsSingleSymbolRenderer Class Reference

Render class to display all the features with a single QgsSymbol. More...

#include <qgssinglesymbolrenderer.h>

Inheritance diagram for QgsSingleSymbolRenderer:
Inheritance graph
[legend]
Collaboration diagram for QgsSingleSymbolRenderer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 QgsSingleSymbolRenderer (QGis::GeometryType type)
 QgsSingleSymbolRenderer (const QgsSingleSymbolRenderer &other)
QgsSingleSymbolRendereroperator= (const QgsSingleSymbolRenderer &other)
virtual ~QgsSingleSymbolRenderer ()
void addSymbol (QgsSymbol *sy)
 Replaces the current mSymbol by sy.
const QgsSymbolsymbol () const
void renderFeature (QgsRenderContext &renderContext, QgsFeature &f, QImage *img, bool selected, double opacity=1.0)
 Renders a feature added in 1.2.
virtual int readXML (const QDomNode &rnode, QgsVectorLayer &vl)
 Reads the renderer configuration from an XML file.
virtual bool writeXML (QDomNode &layer_node, QDomDocument &document, const QgsVectorLayer &vl) const
 Writes the contents of the renderer to a configuration file.
bool needsAttributes () const
 Returns true, attributes needed for single symbol.
QgsAttributeList classificationAttributes () const
 Returns a list of all needed attributes.
void updateSymbolAttributes ()
virtual QString name () const
 Returns the renderers name.
const QList< QgsSymbol * > symbols () const
 Returns a list containing mSymbol.
QgsRendererclone () const
 Returns a deep copy of this renderer.
QgsSymbolsymbolForFeature (const QgsFeature *f)
 Returns renderer symbol for a feature.

Protected Attributes

QgsSymbolmSymbol0
 Object containing symbology information.
QMap< QString, QgsSymbol * > mSymbols
QgsAttributeList mSymbolAttributes
 Cached copy of all underlying symbols required attribute fields.

Detailed Description

Render class to display all the features with a single QgsSymbol.

Definition at line 27 of file qgssinglesymbolrenderer.h.


Constructor & Destructor Documentation

Definition at line 61 of file qgssinglesymbolrenderer.cpp.

Definition at line 88 of file qgssinglesymbolrenderer.cpp.

References mSymbols.


Member Function Documentation

Replaces the current mSymbol by sy.

Definition at line 94 of file qgssinglesymbolrenderer.cpp.

References mSymbol0, mSymbols, and updateSymbolAttributes().

Referenced by readXML(), and QgsSymbologyV2Conversion::rendererV2toV1().

Returns a list of all needed attributes.

Implements QgsRenderer.

Definition at line 239 of file qgssinglesymbolrenderer.cpp.

References mSymbolAttributes.

Returns a deep copy of this renderer.

Implements QgsRenderer.

Definition at line 277 of file qgssinglesymbolrenderer.cpp.

References QgsSingleSymbolRenderer().

QString QgsSingleSymbolRenderer::name ( ) const [virtual]

Returns the renderers name.

Implements QgsRenderer.

Definition at line 267 of file qgssinglesymbolrenderer.cpp.

Referenced by renderFeature().

bool QgsSingleSymbolRenderer::needsAttributes ( ) const [inline, virtual]

Returns true, attributes needed for single symbol.

Implements QgsRenderer.

Definition at line 84 of file qgssinglesymbolrenderer.h.

QgsSingleSymbolRenderer & QgsSingleSymbolRenderer::operator= ( const QgsSingleSymbolRenderer other)
int QgsSingleSymbolRenderer::readXML ( const QDomNode &  rnode,
QgsVectorLayer vl 
) [virtual]

Reads the renderer configuration from an XML file.

Parameters:
rnodethe Dom node to read
vlthe vector layer which will be associated with the renderer
Returns:
0 in case of success, 1 if vector layer has no renderer, 2 if classification field not found

Implements QgsRenderer.

Definition at line 201 of file qgssinglesymbolrenderer.cpp.

References addSymbol(), QgsVectorLayer::geometryType(), QgsRenderer::mGeometryType, QgsDebugMsg, QgsSymbol::readXML(), QgsVectorLayer::setRenderer(), and updateSymbolAttributes().

void QgsSingleSymbolRenderer::renderFeature ( QgsRenderContext renderContext,
QgsFeature f,
QImage *  img,
bool  selected,
double  opacity = 1.0 
) [virtual]
const QgsSymbol * QgsSingleSymbolRenderer::symbol ( ) const [inline]

Definition at line 79 of file qgssinglesymbolrenderer.h.

References mSymbol0.

Referenced by QgsSymbologyV2Conversion::rendererV1toV2().

Returns renderer symbol for a feature.

Note:
: this method was added in version 1.6

Reimplemented from QgsRenderer.

Definition at line 69 of file qgssinglesymbolrenderer.h.

const QList< QgsSymbol * > QgsSingleSymbolRenderer::symbols ( ) const [virtual]

Returns a list containing mSymbol.

Implements QgsRenderer.

Definition at line 272 of file qgssinglesymbolrenderer.cpp.

References mSymbols.

bool QgsSingleSymbolRenderer::writeXML ( QDomNode &  layer_node,
QDomDocument &  document,
const QgsVectorLayer vl 
) const [virtual]

Writes the contents of the renderer to a configuration file.

Writes the contents of the renderer to a configuration file @ return true in case of success

Implements QgsRenderer.

Definition at line 225 of file qgssinglesymbolrenderer.cpp.

References mSymbol0, and QgsSymbol::writeXML().


Member Data Documentation

Object containing symbology information.

Definition at line 73 of file qgssinglesymbolrenderer.h.

Referenced by addSymbol(), operator=(), QgsSingleSymbolRenderer(), renderFeature(), symbol(), updateSymbolAttributes(), and writeXML().

Cached copy of all underlying symbols required attribute fields.

Definition at line 76 of file qgssinglesymbolrenderer.h.

Referenced by classificationAttributes(), and updateSymbolAttributes().

QMap<QString, QgsSymbol*> QgsSingleSymbolRenderer::mSymbols [protected]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines