QgsGraduatedSymbolRenderer Class Reference

#include <qgsgraduatedsymbolrenderer.h>

Inheritance diagram for QgsGraduatedSymbolRenderer:

[legend]Collaboration diagram for QgsGraduatedSymbolRenderer:

[legend]List of all members.

---

Detailed Description

This class contains the information for graduate symbol rendering.

Definition at line 27 of file qgsgraduatedsymbolrenderer.h.

Public Types
enum	Mode { EqualInterval, Quantile, Empty }
Public Member Functions
	QgsGraduatedSymbolRenderer (QGis::GeometryType type, Mode theMode=EqualInterval)
	QgsGraduatedSymbolRenderer (const QgsGraduatedSymbolRenderer &other)
QgsGraduatedSymbolRenderer &	operator= (const QgsGraduatedSymbolRenderer &other)
virtual	~QgsGraduatedSymbolRenderer ()
Mode	mode () const
	Get the mode - which is only really used to be able to reinstate the graduated dialog properties properly, so we dont do anything else besides accessors and mutators in this class.
void	setMode (Mode theMode)
	Set the mode - which is only really used to be able to reinstate the graduated dialog properties properly, so we dont do anything else besides accessors and mutators in this class.
void	addSymbol (QgsSymbol *sy)
	Adds a new item.
int	classificationField () const
	Returns the indes of the classification field.
void	removeSymbols ()
	Removes all symbols.
virtual bool	willRenderFeature (QgsFeature *f)
	Determines if a feature will be rendered or not.
void	renderFeature (QPainter *p, QgsFeature &f, QImage *img, bool selected, double widthScale=1.0, double rasterScaleFactor=1.0)
	Renders an OGRFeature.
void	setClassificationField (int)
	Sets the classicifation field by index.
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 @ return true in case of success.
bool	needsAttributes () const
	Returns true.
QgsAttributeList	classificationAttributes () const
	Returns a list of all needed attributes.
void	updateSymbolAttributes ()
QString	name () const
	Returns the renderers name.
const QList< QgsSymbol * >	symbols () const
	Returns the symbols of the items.
QgsRenderer *	clone () const
	Returns a copy of the renderer (a deep copy on the heap).
Protected Member Functions
QgsSymbol *	symbolForFeature (const QgsFeature *f)
Protected Attributes
Mode	mMode
	The graduation mode.
int	mClassificationField
	Index of the classification field (it must be a numerical field).
QList< QgsSymbol * >	mSymbols
	List holding the symbols for the individual classes.
QgsAttributeList	mSymbolAttributes
	Cached copy of all underlying symbols required attribute fields.

---

Member Enumeration Documentation

enum QgsGraduatedSymbolRenderer::Mode

Enumerator:

EqualInterval
Quantile
Empty

Definition at line 30 of file qgsgraduatedsymbolrenderer.h.

---

Constructor & Destructor Documentation

QgsGraduatedSymbolRenderer::QgsGraduatedSymbolRenderer	(	QGis::GeometryType	type,
		Mode	theMode = EqualInterval
	)

Definition at line 34 of file qgsgraduatedsymbolrenderer.cpp.

References QgsRenderer::mGeometryType.

Referenced by clone().

QgsGraduatedSymbolRenderer::QgsGraduatedSymbolRenderer

(

const QgsGraduatedSymbolRenderer &

other

)

Definition at line 39 of file qgsgraduatedsymbolrenderer.cpp.

References addSymbol(), mClassificationField, QgsRenderer::mGeometryType, mMode, symbols(), and updateSymbolAttributes().

QgsGraduatedSymbolRenderer::~QgsGraduatedSymbolRenderer

(

)

[virtual]

Definition at line 71 of file qgsgraduatedsymbolrenderer.cpp.

---

Member Function Documentation

QgsGraduatedSymbolRenderer & QgsGraduatedSymbolRenderer::operator=

(

const QgsGraduatedSymbolRenderer &

other

)

Definition at line 52 of file qgsgraduatedsymbolrenderer.cpp.

References addSymbol(), mClassificationField, QgsRenderer::mGeometryType, mMode, removeSymbols(), symbols(), and updateSymbolAttributes().

QgsGraduatedSymbolRenderer::Mode QgsGraduatedSymbolRenderer::mode

(

)

const

Get the mode - which is only really used to be able to reinstate the graduated dialog properties properly, so we dont do anything else besides accessors and mutators in this class.

Definition at line 77 of file qgsgraduatedsymbolrenderer.cpp.

References mMode.

void QgsGraduatedSymbolRenderer::setMode

(

Mode

theMode

)

Set the mode - which is only really used to be able to reinstate the graduated dialog properties properly, so we dont do anything else besides accessors and mutators in this class.

Definition at line 86 of file qgsgraduatedsymbolrenderer.cpp.

References mMode.

void QgsGraduatedSymbolRenderer::addSymbol

(

QgsSymbol *

sy

)

[inline]

Adds a new item.

Parameters:

sy

a pointer to the QgsSymbol to be inserted. It has to be created using the new operator and is automatically destroyed when 'removeItems' is called or when this object is destroyed

Definition at line 125 of file qgsgraduatedsymbolrenderer.h.

References mSymbols.

Referenced by operator=(), QgsGraduatedSymbolRenderer(), and readXML().

int QgsGraduatedSymbolRenderer::classificationField

(

)

const [inline]

Returns the indes of the classification field.

Definition at line 130 of file qgsgraduatedsymbolrenderer.h.

References mClassificationField.

Referenced by readXML().

void QgsGraduatedSymbolRenderer::removeSymbols

(

)

Removes all symbols.

Definition at line 100 of file qgsgraduatedsymbolrenderer.cpp.

References mSymbols, and updateSymbolAttributes().

Referenced by operator=().

bool QgsGraduatedSymbolRenderer::willRenderFeature

(

QgsFeature *

f

)

[virtual]

Determines if a feature will be rendered or not.

Parameters:

f

a pointer to the feature to determine if rendering will happen

Reimplemented from QgsRenderer.

Definition at line 113 of file qgsgraduatedsymbolrenderer.cpp.

References symbolForFeature().

void QgsGraduatedSymbolRenderer::renderFeature	(	QPainter *	p,
		QgsFeature &	f,
		QImage *	img,
		bool	selected,
		double	widthScale = 1.0,
		double	rasterScaleFactor = 1.0
	)			[virtual]

Renders an OGRFeature.

Parameters:

	p	a painter (usually the one from the current map canvas)
	f	a pointer to a feature to render
	t	the transform object containing the information how to transform the map coordinates to screen coordinates

Implements QgsRenderer.

Definition at line 118 of file qgsgraduatedsymbolrenderer.cpp.

References QgsFeature::attributeMap(), QgsSymbol::brush(), QgsSymbol::getPointSymbolAsImage(), QgsRenderer::mGeometryType, QgsRenderer::mSelectionColor, QgsSymbol::pen(), QGis::Point, QGis::Polygon, QgsDebugMsg, QgsSymbol::rotationClassificationField(), QgsRenderer::scaleBrush(), QgsSymbol::scaleClassificationField(), and symbolForFeature().

void QgsGraduatedSymbolRenderer::setClassificationField

(

int

)

[inline]

Sets the classicifation field by index.

Parameters:

field

the number of the field to classify

Definition at line 135 of file qgsgraduatedsymbolrenderer.h.

References mClassificationField.

Referenced by readXML().

int QgsGraduatedSymbolRenderer::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 218 of file qgsgraduatedsymbolrenderer.cpp.

References addSymbol(), classificationField(), QgsVectorLayer::dataProvider(), Empty, EqualInterval, QgsVectorDataProvider::fieldNameIndex(), QgsVectorLayer::geometryType(), QgsRenderer::mGeometryType, mMode, Quantile, setClassificationField(), QgsVectorLayer::setRenderer(), and updateSymbolAttributes().

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

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

Implements QgsRenderer.

Definition at line 303 of file qgsgraduatedsymbolrenderer.cpp.

References QgsVectorLayer::dataProvider(), Empty, mClassificationField, mMode, mSymbols, QgsVectorLayer::pendingFields(), and Quantile.

bool QgsGraduatedSymbolRenderer::needsAttributes

(

)

const [inline, virtual]

Returns true.

Implements QgsRenderer.

Definition at line 140 of file qgsgraduatedsymbolrenderer.h.

QgsAttributeList QgsGraduatedSymbolRenderer::classificationAttributes

(

)

const [virtual]

Returns a list of all needed attributes.

Implements QgsRenderer.

Definition at line 265 of file qgsgraduatedsymbolrenderer.cpp.

References mClassificationField, and mSymbolAttributes.

void QgsGraduatedSymbolRenderer::updateSymbolAttributes

(

)

Definition at line 275 of file qgsgraduatedsymbolrenderer.cpp.

References mSymbolAttributes, and mSymbols.

Referenced by operator=(), QgsGraduatedSymbolRenderer(), readXML(), and removeSymbols().

QString QgsGraduatedSymbolRenderer::name

(

)

const [virtual]

Returns the renderers name.

Implements QgsRenderer.

Definition at line 298 of file qgsgraduatedsymbolrenderer.cpp.

const QList< QgsSymbol * > QgsGraduatedSymbolRenderer::symbols

(

)

const [virtual]

Returns the symbols of the items.

Implements QgsRenderer.

Definition at line 95 of file qgsgraduatedsymbolrenderer.cpp.

References mSymbols.

Referenced by operator=(), and QgsGraduatedSymbolRenderer().

QgsRenderer * QgsGraduatedSymbolRenderer::clone

(

)

const [virtual]

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

Implements QgsRenderer.

Definition at line 364 of file qgsgraduatedsymbolrenderer.cpp.

References QgsGraduatedSymbolRenderer().

QgsSymbol * QgsGraduatedSymbolRenderer::symbolForFeature

(

const QgsFeature *

f

)

[protected]

Definition at line 195 of file qgsgraduatedsymbolrenderer.cpp.

References QgsFeature::attributeMap(), mClassificationField, and mSymbols.

Referenced by renderFeature(), and willRenderFeature().

---

Member Data Documentation

Mode QgsGraduatedSymbolRenderer::mMode [protected]

The graduation mode.

Definition at line 109 of file qgsgraduatedsymbolrenderer.h.

Referenced by mode(), operator=(), QgsGraduatedSymbolRenderer(), readXML(), setMode(), and writeXML().

int QgsGraduatedSymbolRenderer::mClassificationField [protected]

Index of the classification field (it must be a numerical field).

Definition at line 112 of file qgsgraduatedsymbolrenderer.h.

Referenced by classificationAttributes(), classificationField(), operator=(), QgsGraduatedSymbolRenderer(), setClassificationField(), symbolForFeature(), and writeXML().

QList<QgsSymbol*> QgsGraduatedSymbolRenderer::mSymbols [protected]

List holding the symbols for the individual classes.

Definition at line 115 of file qgsgraduatedsymbolrenderer.h.

Referenced by addSymbol(), removeSymbols(), symbolForFeature(), symbols(), updateSymbolAttributes(), and writeXML().

QgsAttributeList QgsGraduatedSymbolRenderer::mSymbolAttributes [protected]

Cached copy of all underlying symbols required attribute fields.

Definition at line 120 of file qgsgraduatedsymbolrenderer.h.

Referenced by classificationAttributes(), and updateSymbolAttributes().

---

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

• src/core/renderer/qgsgraduatedsymbolrenderer.h
• src/core/renderer/qgsgraduatedsymbolrenderer.cpp

---