#include <qgsuniquevaluerenderer.h>

Inheritance diagram for QgsUniqueValueRenderer:

Collaboration diagram for QgsUniqueValueRenderer:

Public Member Functions
	QgsUniqueValueRenderer (QGis::GeometryType type)
	QgsUniqueValueRenderer (const QgsUniqueValueRenderer &other)
virtual	~QgsUniqueValueRenderer ()
QgsAttributeList	classificationAttributes () const
	Returns a list with indexes of classification attributes.
int	classificationField () const
	Returns the index of the classification field.
void	clearValues ()
	Removes all entries from mEntries.
QgsRenderer *	clone () const
	Returns a copy of the renderer (a deep copy on the heap)
void	insertValue (QString name, QgsSymbol *symbol)
	Inserts an entry into mEntries.
QString	name () const
	Returns the renderers name.
bool	needsAttributes () const
	Returns true, if attribute values are used by the renderer and false otherwise.
QgsUniqueValueRenderer &	operator= (const QgsUniqueValueRenderer &other)
int	readXML (const QDomNode &rnode, QgsVectorLayer &vl)
	Reads the renderer configuration from an XML file.
void	renderFeature (QgsRenderContext &renderContext, QgsFeature &f, QImage *img, bool selected, double opacity=1.0)
	Render feature added in 1.2.
void	setClassificationField (int field)
	Sets the Field index used for classification.
QgsSymbol *	symbolForFeature (const QgsFeature *f)
	Returns the symbol for a feature or 0 if there isn't any.
const QMap< QString, QgsSymbol * >	symbolMap () const
	Return the classification map.
const QList< QgsSymbol * >	symbols () const
	Return symbology items.
void	updateSymbolAttributes ()
virtual bool	willRenderFeature (QgsFeature *f)
	Determines if a feature will be rendered or not.
virtual bool	writeXML (QDomNode &layer_node, QDomDocument &document, const QgsVectorLayer &vl) const
	Writes the contents of the renderer to a configuration file.
Protected Attributes
int	mClassificationField
	Field index used for classification.
QgsAttributeList	mSymbolAttributes
	Cached copy of all underlying symbols required attribute fields.
bool	mSymbolAttributesDirty
QMap< QString, QgsSymbol * >	mSymbols
	Symbols for the unique values.

Detailed Description

Definition at line 23 of file qgsuniquevaluerenderer.h.

Constructor & Destructor Documentation

QgsUniqueValueRenderer::QgsUniqueValueRenderer ( QGis::GeometryType type )

Definition at line 32 of file qgsuniquevaluerenderer.cpp.

References QgsRenderer::mGeometryType, and mSymbolAttributesDirty.

Referenced by clone().

QgsUniqueValueRenderer::QgsUniqueValueRenderer ( const QgsUniqueValueRenderer & other )

Definition at line 38 of file qgsuniquevaluerenderer.cpp.

References insertValue(), mClassificationField, QgsRenderer::mGeometryType, mSymbols, and updateSymbolAttributes().

QgsUniqueValueRenderer::~QgsUniqueValueRenderer ( ) [virtual]

Definition at line 68 of file qgsuniquevaluerenderer.cpp.

References mSymbols.

Member Function Documentation

QgsAttributeList QgsUniqueValueRenderer::classificationAttributes ( ) const [virtual]

Returns a list with indexes of classification attributes.

Implements QgsRenderer.

Definition at line 285 of file qgsuniquevaluerenderer.cpp.

References mClassificationField, and mSymbolAttributes.

int QgsUniqueValueRenderer::classificationField ( ) const

Returns the index of the classification field.

Definition at line 87 of file qgsuniquevaluerenderer.cpp.

References mClassificationField.

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

void QgsUniqueValueRenderer::clearValues ( )

Removes all entries from mEntries.

Definition at line 243 of file qgsuniquevaluerenderer.cpp.

References mSymbols, and updateSymbolAttributes().

Referenced by operator=().

QgsRenderer * QgsUniqueValueRenderer::clone ( ) const [virtual]

Returns a copy of the renderer (a deep copy on the heap)

Implements QgsRenderer.

Definition at line 327 of file qgsuniquevaluerenderer.cpp.

References QgsUniqueValueRenderer().

void QgsUniqueValueRenderer::insertValue	(	QString	name,
		QgsSymbol *	symbol
	)

Inserts an entry into mEntries.

The render items have to be created with the new operator and are automatically destroyed if not needed anymore

Definition at line 76 of file qgsuniquevaluerenderer.cpp.

References mSymbolAttributesDirty, and mSymbols.

Referenced by operator=(), QgsUniqueValueRenderer(), readXML(), and QgsSymbologyV2Conversion::rendererV2toV1().

QString QgsUniqueValueRenderer::name ( ) const [virtual]

Returns the renderers name.

Implements QgsRenderer.

Definition at line 280 of file qgsuniquevaluerenderer.cpp.

Referenced by renderFeature().

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

Returns true, if attribute values are used by the renderer and false otherwise.

Implements QgsRenderer.

Definition at line 84 of file qgsuniquevaluerenderer.h.

QgsUniqueValueRenderer & QgsUniqueValueRenderer::operator= ( const QgsUniqueValueRenderer & other )

Definition at line 51 of file qgsuniquevaluerenderer.cpp.

References clearValues(), insertValue(), mClassificationField, QgsRenderer::mGeometryType, mSymbols, and updateSymbolAttributes().

int QgsUniqueValueRenderer::readXML	(	const QDomNode &	rnode,
		QgsVectorLayer &	vl
	)		`[virtual]`

Reads the renderer configuration from an XML file.

Parameters:

rnode	the Dom node to read
vl	the 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 211 of file qgsuniquevaluerenderer.cpp.

References classificationField(), QgsVectorLayer::dataProvider(), QgsVectorLayer::fieldNameIndex(), QgsVectorLayer::geometryType(), insertValue(), QgsSymbol::lowerValue(), QgsRenderer::mGeometryType, QgsSymbol::readXML(), setClassificationField(), QgsVectorLayer::setRenderer(), and updateSymbolAttributes().

void QgsUniqueValueRenderer::renderFeature	(	QgsRenderContext &	renderContext,
		QgsFeature &	f,
		QImage *	img,
		bool	selected,
		double	opacity = `1.0`
	)		`[virtual]`