#include <qgscategorizedsymbolrendererv2.h>

Inheritance diagram for QgsCategorizedSymbolRendererV2:

Collaboration diagram for QgsCategorizedSymbolRendererV2:

Public Member Functions
	QgsCategorizedSymbolRendererV2 (QString attrName=QString(), QgsCategoryList categories=QgsCategoryList())
virtual	~QgsCategorizedSymbolRendererV2 ()
virtual QgsSymbolV2 *	symbolForFeature (QgsFeature &feature)
	to be overridden
virtual void	startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
virtual void	stopRender (QgsRenderContext &context)
virtual QList< QString >	usedAttributes ()
virtual QString	dump () const
	for debugging
virtual QgsFeatureRendererV2 *	clone ()
virtual void	toSld (QDomDocument &doc, QDomElement &element) const
	used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual int	capabilities ()
	returns bitwise OR-ed capabilities of the renderer
virtual QgsSymbolV2List	symbols ()
	for symbol levels
void	updateSymbols (QgsSymbolV2 *sym)
const QgsCategoryList &	categories ()
int	categoryIndexForValue (QVariant val)
	return index of category with specified value (-1 if not found)
bool	updateCategoryValue (int catIndex, const QVariant &value)
bool	updateCategorySymbol (int catIndex, QgsSymbolV2 *symbol)
bool	updateCategoryLabel (int catIndex, QString label)
void	addCategory (const QgsRendererCategoryV2 &category)
bool	deleteCategory (int catIndex)
void	deleteAllCategories ()
void	moveCategory (int from, int to)
	Moves the category at index position from to index position to.
void	sortByValue (Qt::SortOrder order=Qt::AscendingOrder)
void	sortByLabel (Qt::SortOrder order=Qt::AscendingOrder)
QString	classAttribute () const
void	setClassAttribute (QString attr)
virtual QDomElement	save (QDomDocument &doc)
	store renderer info to XML element
virtual QgsLegendSymbologyList	legendSymbologyItems (QSize iconSize)
	return a list of symbology items for the legend
virtual QgsLegendSymbolList	legendSymbolItems (double scaleDenominator=-1, QString rule=QString())
	return a list of item text / symbol
QgsSymbolV2 *	sourceSymbol ()
void	setSourceSymbol (QgsSymbolV2 *sym)
QgsVectorColorRampV2 *	sourceColorRamp ()
void	setSourceColorRamp (QgsVectorColorRampV2 *ramp)
bool	invertedColorRamp ()
void	setInvertedColorRamp (bool inverted)
void	setRotationField (QString fieldOrExpression)
QString	rotationField () const
void	setSizeScaleField (QString fieldOrExpression)
QString	sizeScaleField () const
void	setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
QgsSymbolV2::ScaleMethod	scaleMethod () const
Public Member Functions inherited from QgsFeatureRendererV2
QString	type () const
virtual	~QgsFeatureRendererV2 ()
virtual bool	renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
bool	usingSymbolLevels () const
void	setUsingSymbolLevels (bool usingSymbolLevels)
virtual QDomElement	writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const
	create the SLD UserStyle element following the SLD v1.1 specs
void	setVertexMarkerAppearance (int type, int size)
	set type and size of editing vertex markers for subsequent rendering
virtual bool	willRenderFeature (QgsFeature &feat)
	return whether the renderer will render a feature or not.
virtual QgsSymbolV2List	symbolsForFeature (QgsFeature &feat)
	return list of symbols used for rendering the feature.

Static Public Member Functions
static QgsFeatureRendererV2 *	create (QDomElement &element)
	create renderer from XML element
Static Public Member Functions inherited from QgsFeatureRendererV2
static QgsFeatureRendererV2 *	defaultRenderer (QGis::GeometryType geomType)
	return a new renderer - used by default in vector layers
static QgsFeatureRendererV2 *	load (QDomElement &symbologyElem)
	create a renderer from XML element
static QgsFeatureRendererV2 *	loadSld (const QDomNode &node, QGis::GeometryType geomType, QString &errorMessage)
	create a new renderer according to the information contained in the UserStyle element of a SLD style document

Protected Member Functions
void	rebuildHash ()
QgsSymbolV2 *	symbolForValue (QVariant value)
Protected Member Functions inherited from QgsFeatureRendererV2
	QgsFeatureRendererV2 (QString type)
void	renderFeatureWithSymbol (QgsFeature &feature, QgsSymbolV2 *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
void	renderVertexMarker (QPointF &pt, QgsRenderContext &context)
	render editing vertex marker at specified point
void	renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
	render editing vertex marker for a polyline
void	renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
	render editing vertex marker for a polygon
void	setScaleMethodToSymbol (QgsSymbolV2 *symbol, int scaleMethod)

Protected Attributes
QString	mAttrName
QgsCategoryList	mCategories
QScopedPointer< QgsSymbolV2 >	mSourceSymbol
QScopedPointer < QgsVectorColorRampV2 >	mSourceColorRamp
bool	mInvertedColorRamp
QScopedPointer< QgsExpression >	mRotation
QScopedPointer< QgsExpression >	mSizeScale
QgsSymbolV2::ScaleMethod	mScaleMethod
QScopedPointer< QgsExpression >	mExpression
int	mAttrNum
	attribute index (derived from attribute name in startRender)
QHash< QString, QgsSymbolV2 * >	mSymbolHash
	hashtable for faster access to symbols
QHash< QString, QgsSymbolV2 * >	mTempSymbols
	temporary symbols, used for data-defined rotation and scaling
Protected Attributes inherited from QgsFeatureRendererV2
QString	mType
bool	mUsingSymbolLevels
int	mCurrentVertexMarkerType
	The current type of editing marker.
int	mCurrentVertexMarkerSize
	The current size of editing marker.

Additional Inherited Members
Public Types inherited from QgsFeatureRendererV2
enum	Capabilities { SymbolLevels = 1, RotationField = 1 << 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 }
Static Protected Member Functions inherited from QgsFeatureRendererV2
static const unsigned char *	_getPoint (QPointF &pt, QgsRenderContext &context, const unsigned char *wkb)
static const unsigned char *	_getLineString (QPolygonF &pts, QgsRenderContext &context, const unsigned char *wkb)
static const unsigned char *	_getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, const unsigned char *wkb)

Detailed Description

Definition at line 65 of file qgscategorizedsymbolrendererv2.h.

Constructor & Destructor Documentation

QgsCategorizedSymbolRendererV2::QgsCategorizedSymbolRendererV2	(	QString	attrName = `QString()`,
		QgsCategoryList	categories = `QgsCategoryList()`
	)

Definition at line 130 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, QgsDebugMsg, and QgsRendererCategoryV2::symbol().

Referenced by clone(), and create().

QgsCategorizedSymbolRendererV2::~QgsCategorizedSymbolRendererV2 ( )

virtual

Definition at line 149 of file qgscategorizedsymbolrendererv2.cpp.

Member Function Documentation

void QgsCategorizedSymbolRendererV2::addCategory ( const QgsRendererCategoryV2 & category )

Definition at line 267 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, QgsDebugMsg, and QgsRendererCategoryV2::symbol().

virtual int QgsCategorizedSymbolRendererV2::capabilities ( )

inlinevirtual

returns bitwise OR-ed capabilities of the renderer

Note: added in 2.0

Reimplemented from QgsFeatureRendererV2.

Definition at line 89 of file qgscategorizedsymbolrendererv2.h.

References QgsFeatureRendererV2::Filter.

const QgsCategoryList& QgsCategorizedSymbolRendererV2::categories ( )

inline

Definition at line 95 of file qgscategorizedsymbolrendererv2.h.

Referenced by QgsAttributeEditor::createAttributeEditor(), legendSymbologyItems(), and QgsRuleBasedRendererV2::refineRuleCategories().

int QgsCategorizedSymbolRendererV2::categoryIndexForValue ( QVariant val )

return index of category with specified value (-1 if not found)

Definition at line 233 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

QString QgsCategorizedSymbolRendererV2::classAttribute ( ) const

inline

Definition at line 114 of file qgscategorizedsymbolrendererv2.h.

Referenced by legendSymbolItems(), legendSymbologyItems(), and QgsRuleBasedRendererV2::refineRuleCategories().

QgsFeatureRendererV2 * QgsCategorizedSymbolRendererV2::clone ( )

virtual

QgsFeatureRendererV2 * QgsCategorizedSymbolRendererV2::create ( QDomElement & element )

static

create renderer from XML element

Definition at line 464 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::clearSymbolMap(), QgsSymbolLayerV2Utils::decodeScaleMethod(), QgsSymbolLayerV2Utils::loadColorRamp(), QgsSymbolLayerV2Utils::loadSymbols(), QgsCategorizedSymbolRendererV2(), setInvertedColorRamp(), setRotationField(), setScaleMethod(), setSizeScaleField(), setSourceColorRamp(), and setSourceSymbol().

Referenced by QgsRendererV2Registry::QgsRendererV2Registry().

void QgsCategorizedSymbolRendererV2::deleteAllCategories ( )

Definition at line 288 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

bool QgsCategorizedSymbolRendererV2::deleteCategory ( int catIndex )

Definition at line 279 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

QString QgsCategorizedSymbolRendererV2::dump ( ) const

virtual

for debugging

Reimplemented from QgsFeatureRendererV2.

Definition at line 414 of file qgscategorizedsymbolrendererv2.cpp.

References mAttrName, and mCategories.

bool QgsCategorizedSymbolRendererV2::invertedColorRamp ( )

inline

Note: added in 2.1

Definition at line 138 of file qgscategorizedsymbolrendererv2.h.

QgsLegendSymbolList QgsCategorizedSymbolRendererV2::legendSymbolItems	(	double	scaleDenominator = `-1`,
		QString	rule = `QString()`
	)

virtual

return a list of item text / symbol

Note: this method was added in version 1.5; not available in python bindings

Reimplemented from QgsFeatureRendererV2.

Definition at line 624 of file qgscategorizedsymbolrendererv2.cpp.

References classAttribute(), QgsRendererCategoryV2::label(), mCategories, and QgsRendererCategoryV2::symbol().

QgsLegendSymbologyList QgsCategorizedSymbolRendererV2::legendSymbologyItems ( QSize iconSize )

virtual

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

Definition at line 603 of file qgscategorizedsymbolrendererv2.cpp.

References categories(), classAttribute(), QgsRendererCategoryV2::label(), QgsRendererCategoryV2::symbol(), and QgsSymbolLayerV2Utils::symbolPreviewPixmap().

void QgsCategorizedSymbolRendererV2::moveCategory	(	int	from,
		int	to
	)

Moves the category at index position from to index position to.

Definition at line 293 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

void QgsCategorizedSymbolRendererV2::rebuildHash ( )

protected

Definition at line 153 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, mSymbolHash, QgsRendererCategoryV2::symbol(), and QgsRendererCategoryV2::value().

Referenced by startRender().

QString QgsCategorizedSymbolRendererV2::rotationField ( ) const

virtual

Note: added in 1.6

Reimplemented from QgsFeatureRendererV2.

Definition at line 670 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::fieldOrExpressionFromExpression(), and mRotation.

Referenced by clone().

QDomElement QgsCategorizedSymbolRendererV2::save ( QDomDocument & doc )

virtual

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

Definition at line 538 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::encodeScaleMethod(), QgsSymbolLayerV2Utils::fieldOrExpressionFromExpression(), QgsRendererCategoryV2::label(), mAttrName, mCategories, mInvertedColorRamp, mRotation, mScaleMethod, mSizeScale, mSourceColorRamp, mSourceSymbol, QgsFeatureRendererV2::mUsingSymbolLevels, RENDERER_TAG_NAME, QgsSymbolLayerV2Utils::saveColorRamp(), QgsSymbolLayerV2Utils::saveSymbols(), QgsRendererCategoryV2::symbol(), symbols(), and QgsRendererCategoryV2::value().

QgsSymbolV2::ScaleMethod QgsCategorizedSymbolRendererV2::scaleMethod ( ) const

inline

Note: added in 2.0

Definition at line 154 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), and setScaleMethod().

void QgsCategorizedSymbolRendererV2::setClassAttribute ( QString attr )

inline

Definition at line 115 of file qgscategorizedsymbolrendererv2.h.

void QgsCategorizedSymbolRendererV2::setInvertedColorRamp ( bool inverted )

inline

Definition at line 139 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setRotationField ( QString fieldOrExpression )

virtual

Note: added in 1.6

Reimplemented from QgsFeatureRendererV2.

Definition at line 665 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::fieldOrExpressionToExpression(), and mRotation.

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setScaleMethod ( QgsSymbolV2::ScaleMethod scaleMethod )

Note: added in 2.0

Definition at line 697 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, mScaleMethod, scaleMethod(), and QgsFeatureRendererV2::setScaleMethodToSymbol().

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setSizeScaleField ( QString fieldOrExpression )

Note: added in 1.6

Definition at line 675 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::fieldOrExpressionToExpression(), and mSizeScale.

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setSourceColorRamp ( QgsVectorColorRampV2 * ramp )

Definition at line 660 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceColorRamp.

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setSourceSymbol ( QgsSymbolV2 * sym )

Definition at line 651 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceSymbol.

Referenced by clone(), and create().

QString QgsCategorizedSymbolRendererV2::sizeScaleField ( ) const

Note: added in 1.6

Definition at line 680 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::fieldOrExpressionFromExpression(), and mSizeScale.

Referenced by clone().

void QgsCategorizedSymbolRendererV2::sortByLabel ( Qt::SortOrder order = Qt::AscendingOrder )

Definition at line 330 of file qgscategorizedsymbolrendererv2.cpp.

References labelGreaterThan(), labelLessThan(), and mCategories.

void QgsCategorizedSymbolRendererV2::sortByValue ( Qt::SortOrder order = Qt::AscendingOrder )

Definition at line 308 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, valueGreaterThan(), and valueLessThan().

QgsVectorColorRampV2 * QgsCategorizedSymbolRendererV2::sourceColorRamp ( )

Definition at line 656 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceColorRamp.

QgsSymbolV2 * QgsCategorizedSymbolRendererV2::sourceSymbol ( )

Definition at line 647 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceSymbol.

void QgsCategorizedSymbolRendererV2::startRender	(	QgsRenderContext &	context,
		const QgsVectorLayer *	vlayer
	)

virtual

Implements QgsFeatureRendererV2.

Definition at line 342 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolV2::clone(), QgsSymbolV2::DataDefinedRotation, QgsSymbolV2::DataDefinedSizeScale, QgsVectorLayer::fieldNameIndex(), mAttrName, mAttrNum, mCategories, mExpression, mRotation, mSizeScale, mTempSymbols, QgsVectorLayer::pendingFields(), rebuildHash(), QgsSymbolV2::setRenderHints(), and QgsSymbolV2::startRender().

void QgsCategorizedSymbolRendererV2::stopRender ( QgsRenderContext & context )

virtual

Implements QgsFeatureRendererV2.

Definition at line 372 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, mExpression, and mTempSymbols.

QgsSymbolV2 * QgsCategorizedSymbolRendererV2::symbolForFeature ( QgsFeature & feature )

virtual

to be overridden

Parameters

feature feature

Returns: returns pointer to symbol or 0 if symbol was not found

Implements QgsFeatureRendererV2.

Definition at line 184 of file qgscategorizedsymbolrendererv2.cpp.

References QgsFeature::attributes(), QgsSymbolV2::Line, QgsSymbolV2::Marker, mAttrNum, mExpression, mRotation, mScaleMethod, mSizeScale, mTempSymbols, QgsMarkerSymbolV2::setAngle(), QgsMarkerSymbolV2::setScaleMethod(), QgsMarkerSymbolV2::setSize(), QgsLineSymbolV2::setWidth(), size, symbolForValue(), and QgsSymbolV2::type().

QgsSymbolV2 * QgsCategorizedSymbolRendererV2::symbolForValue ( QVariant value )

protected

Definition at line 164 of file qgscategorizedsymbolrendererv2.cpp.

References mSymbolHash, QgsDebugMsg, and QgsDebugMsgLevel.

Referenced by symbolForFeature().

QgsSymbolV2List QgsCategorizedSymbolRendererV2::symbols ( )

virtual

for symbol levels

Implements QgsFeatureRendererV2.

Definition at line 456 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

Referenced by save().

void QgsCategorizedSymbolRendererV2::toSld	(	QDomDocument &	doc,
		QDomElement &	element
	)		const

virtual

used from subclasses to create SLD Rule elements following SLD v1.1 specs

Note: added in 1.9

Reimplemented from QgsFeatureRendererV2.

Definition at line 439 of file qgscategorizedsymbolrendererv2.cpp.

References mAttrName, mCategories, mRotation, and mSizeScale.

bool QgsCategorizedSymbolRendererV2::updateCategoryLabel	(	int	catIndex,
		QString	label
	)

Definition at line 259 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

bool QgsCategorizedSymbolRendererV2::updateCategorySymbol	(	int	catIndex,
		QgsSymbolV2 *	symbol
	)

Definition at line 251 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

Referenced by updateSymbols().

bool QgsCategorizedSymbolRendererV2::updateCategoryValue	(	int	catIndex,
		const QVariant &	value
	)

Definition at line 243 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

void QgsCategorizedSymbolRendererV2::updateSymbols ( QgsSymbolV2 * sym )

Note: added in 2.0

Definition at line 685 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolV2::clone(), QgsSymbolV2::color(), mCategories, QgsSymbolV2::setColor(), QgsRendererCategoryV2::symbol(), and updateCategorySymbol().

QList< QString > QgsCategorizedSymbolRendererV2::usedAttributes ( )

virtual

Implements QgsFeatureRendererV2.

Definition at line 389 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolLayerV2Utils::fieldOrExpressionToExpression(), mAttrName, mCategories, mRotation, mSizeScale, and QgsSymbolV2::usedAttributes().

Member Data Documentation

QString QgsCategorizedSymbolRendererV2::mAttrName

protected

Definition at line 157 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), dump(), save(), startRender(), toSld(), and usedAttributes().

int QgsCategorizedSymbolRendererV2::mAttrNum

protected

attribute index (derived from attribute name in startRender)

Definition at line 168 of file qgscategorizedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

QgsCategoryList QgsCategorizedSymbolRendererV2::mCategories

protected

QScopedPointer<QgsExpression> QgsCategorizedSymbolRendererV2::mExpression

protected

Definition at line 165 of file qgscategorizedsymbolrendererv2.h.

Referenced by startRender(), stopRender(), and symbolForFeature().

bool QgsCategorizedSymbolRendererV2::mInvertedColorRamp

protected

Definition at line 161 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), and save().

QScopedPointer<QgsExpression> QgsCategorizedSymbolRendererV2::mRotation

protected

Definition at line 162 of file qgscategorizedsymbolrendererv2.h.

Referenced by rotationField(), save(), setRotationField(), startRender(), symbolForFeature(), toSld(), and usedAttributes().

QgsSymbolV2::ScaleMethod QgsCategorizedSymbolRendererV2::mScaleMethod

protected

Definition at line 164 of file qgscategorizedsymbolrendererv2.h.

Referenced by save(), setScaleMethod(), and symbolForFeature().

QScopedPointer<QgsExpression> QgsCategorizedSymbolRendererV2::mSizeScale

protected

Definition at line 163 of file qgscategorizedsymbolrendererv2.h.

Referenced by save(), setSizeScaleField(), sizeScaleField(), startRender(), symbolForFeature(), toSld(), and usedAttributes().

QScopedPointer<QgsVectorColorRampV2> QgsCategorizedSymbolRendererV2::mSourceColorRamp

protected

Definition at line 160 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), save(), setSourceColorRamp(), and sourceColorRamp().

QScopedPointer<QgsSymbolV2> QgsCategorizedSymbolRendererV2::mSourceSymbol

protected

Definition at line 159 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), save(), setSourceSymbol(), and sourceSymbol().

QHash<QString, QgsSymbolV2*> QgsCategorizedSymbolRendererV2::mSymbolHash

protected

hashtable for faster access to symbols

Definition at line 171 of file qgscategorizedsymbolrendererv2.h.

Referenced by rebuildHash(), and symbolForValue().

QHash<QString, QgsSymbolV2*> QgsCategorizedSymbolRendererV2::mTempSymbols

protected

temporary symbols, used for data-defined rotation and scaling

Definition at line 174 of file qgscategorizedsymbolrendererv2.h.

Referenced by startRender(), stopRender(), and symbolForFeature().

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

/tmp/buildd/qgis-2.2.0+wheezy1/src/core/symbology-ng/qgscategorizedsymbolrendererv2.h
/tmp/buildd/qgis-2.2.0+wheezy1/src/core/symbology-ng/qgscategorizedsymbolrendererv2.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation