QgsSingleSymbolRendererV2 Class Reference

#include <qgssinglesymbolrendererv2.h>

Inheritance diagram for QgsSingleSymbolRendererV2:

Public Member Functions
	QgsSingleSymbolRendererV2 (QgsSymbolV2 *symbol)
virtual	~QgsSingleSymbolRendererV2 ()
virtual QgsSymbolV2 *	symbolForFeature (QgsFeature &feature)
	to be overridden
virtual QgsSymbolV2 *	originalSymbolForFeature (QgsFeature &feature)
	Return symbol for feature.
virtual void	startRender (QgsRenderContext &context, const QgsFields &fields)
virtual void	stopRender (QgsRenderContext &context)
virtual QList< QString >	usedAttributes ()
QgsSymbolV2 *	symbol () const
void	setSymbol (QgsSymbolV2 *s)
void	setRotationField (QString fieldOrExpression)
	sets rotation field of renderer (if supported by the renderer)
QString	rotationField () const
	return rotation field name (or empty string if not set or not supported by renderer)
void	setSizeScaleField (QString fieldOrExpression)
QString	sizeScaleField () const
void	setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
QgsSymbolV2::ScaleMethod	scaleMethod () const
virtual QString	dump () const
	for debugging
virtual QgsFeatureRendererV2 *	clone () const
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
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
virtual QgsLegendSymbolListV2	legendSymbolItemsV2 () const
	Return a list of symbology items for the legend.
Public Member Functions inherited from QgsFeatureRendererV2
QString	type () const
virtual Q_DECL_DEPRECATED void	startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
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
virtual bool	legendSymbolItemsCheckable () const
	items of symbology items in legend should be checkable
virtual bool	legendSymbolItemChecked (QString key)
	items of symbology items in legend is checked
virtual void	checkLegendSymbolItem (QString key, bool state=true)
	item in symbology was checked
virtual QString	legendClassificationAttribute () const
	If supported by the renderer, return classification attribute for the use in legend.
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.
virtual QgsSymbolV2List	originalSymbolsForFeature (QgsFeature &feat)
	Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()

Static Public Member Functions
static QgsFeatureRendererV2 *	createFromSld (QDomElement &element, QGis::GeometryType geomType)
static QgsFeatureRendererV2 *	create (QDomElement &element)
	create renderer from XML element
static QgsSingleSymbolRendererV2 *	convertFromRenderer (const QgsFeatureRendererV2 *renderer)
	creates a QgsSingleSymbolRendererV2 from an existing renderer.
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 Attributes
QScopedPointer< QgsSymbolV2 >	mSymbol
QScopedPointer< QgsExpression >	mRotation
QScopedPointer< QgsExpression >	mSizeScale
QgsSymbolV2::ScaleMethod	mScaleMethod
QScopedPointer< QgsSymbolV2 >	mTempSymbol
double	mOrigSize
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 }
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)
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)

Constructor & Destructor Documentation

QgsSingleSymbolRendererV2::QgsSingleSymbolRendererV2

(

QgsSymbolV2 *

symbol

)

QgsSingleSymbolRendererV2::~QgsSingleSymbolRendererV2 ( )

virtual

Member Function Documentation

virtual int QgsSingleSymbolRendererV2::capabilities ( )

inlinevirtual

returns bitwise OR-ed capabilities of the renderer

Reimplemented from QgsFeatureRendererV2.

QgsFeatureRendererV2 * QgsSingleSymbolRendererV2::clone ( ) const

virtual

Implements QgsFeatureRendererV2.

QgsSingleSymbolRendererV2 * QgsSingleSymbolRendererV2::convertFromRenderer ( const QgsFeatureRendererV2 *  renderer )

static

creates a QgsSingleSymbolRendererV2 from an existing renderer.

Note

added in 2.5

Returns

a new renderer if the conversion was possible, otherwise 0.

QgsFeatureRendererV2 * QgsSingleSymbolRendererV2::create ( QDomElement &  element )

static

create renderer from XML element

QgsFeatureRendererV2 * QgsSingleSymbolRendererV2::createFromSld ( QDomElement &  element, QGis::GeometryType  geomType  )

static

QString QgsSingleSymbolRendererV2::dump ( ) const

virtual

for debugging

Reimplemented from QgsFeatureRendererV2.

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

virtual

return a list of item text / symbol

Note

not available in python bindings

Reimplemented from QgsFeatureRendererV2.

QgsLegendSymbolListV2 QgsSingleSymbolRendererV2::legendSymbolItemsV2 ( ) const

virtual

Return a list of symbology items for the legend.

Better choice than legendSymbolItems().

Note

added in 2.6

Reimplemented from QgsFeatureRendererV2.

QgsLegendSymbologyList QgsSingleSymbolRendererV2::legendSymbologyItems ( QSize  iconSize )

virtual

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

QgsSymbolV2 * QgsSingleSymbolRendererV2::originalSymbolForFeature ( QgsFeature &  feature )

virtual

Return symbol for feature.

The difference compared to symbolForFeature() is that it returns original symbol which can be used as an identifier for renderer's rule - the former may return a temporary replacement of a symbol for use in rendering.

Note

added in 2.6

Reimplemented from QgsFeatureRendererV2.

QString QgsSingleSymbolRendererV2::rotationField ( ) const

virtual

return rotation field name (or empty string if not set or not supported by renderer)

Reimplemented from QgsFeatureRendererV2.

QDomElement QgsSingleSymbolRendererV2::save ( QDomDocument &  doc )

virtual

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

QgsSymbolV2::ScaleMethod QgsSingleSymbolRendererV2::scaleMethod ( ) const

inline

void QgsSingleSymbolRendererV2::setRotationField ( QString  fieldName )

virtual

sets rotation field of renderer (if supported by the renderer)

Reimplemented from QgsFeatureRendererV2.

void QgsSingleSymbolRendererV2::setScaleMethod

(

QgsSymbolV2::ScaleMethod

scaleMethod

)

void QgsSingleSymbolRendererV2::setSizeScaleField

(

QString

fieldOrExpression

)

void QgsSingleSymbolRendererV2::setSymbol

(

QgsSymbolV2 *

s

)

QString QgsSingleSymbolRendererV2::sizeScaleField

(

)

const

void QgsSingleSymbolRendererV2::startRender ( QgsRenderContext &  context, const QgsFields &  fields  )

virtual

Implements QgsFeatureRendererV2.

void QgsSingleSymbolRendererV2::stopRender ( QgsRenderContext &  context )

virtual

Implements QgsFeatureRendererV2.

QgsSymbolV2 * QgsSingleSymbolRendererV2::symbol

(

)

const

QgsSymbolV2 * QgsSingleSymbolRendererV2::symbolForFeature ( QgsFeature &  feature )

virtual

to be overridden

Parameters

feature

feature

Returns

returns pointer to symbol or 0 if symbol was not found

Implements QgsFeatureRendererV2.

QgsSymbolV2List QgsSingleSymbolRendererV2::symbols ( )

virtual

for symbol levels

Implements QgsFeatureRendererV2.

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

virtual

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

Reimplemented from QgsFeatureRendererV2.

QList< QString > QgsSingleSymbolRendererV2::usedAttributes ( )

virtual

Implements QgsFeatureRendererV2.

Member Data Documentation

double QgsSingleSymbolRendererV2::mOrigSize

protected

QScopedPointer<QgsExpression> QgsSingleSymbolRendererV2::mRotation

protected

QgsSymbolV2::ScaleMethod QgsSingleSymbolRendererV2::mScaleMethod

protected

QScopedPointer<QgsExpression> QgsSingleSymbolRendererV2::mSizeScale

protected

QScopedPointer<QgsSymbolV2> QgsSingleSymbolRendererV2::mSymbol

protected

QScopedPointer<QgsSymbolV2> QgsSingleSymbolRendererV2::mTempSymbol

protected

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgssinglesymbolrendererv2.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgssinglesymbolrendererv2.cpp