Quantum GIS API Documentation  1.7.4
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
QgsCategorizedSymbolRendererV2 Class Reference

#include <qgscategorizedsymbolrendererv2.h>

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

List of all members.

Public Member Functions

 QgsCategorizedSymbolRendererV2 (QString attrName=QString(), QgsCategoryList categories=QgsCategoryList())
virtual ~QgsCategorizedSymbolRendererV2 ()
virtual QgsSymbolV2 * symbolForFeature (QgsFeature &feature)
virtual void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
virtual void stopRender (QgsRenderContext &context)
virtual QList< QString > usedAttributes ()
virtual QString dump ()
 for debugging
virtual QgsFeatureRendererV2 * clone ()
virtual QgsSymbolV2List symbols ()
 for symbol levels
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 ()
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 ()
 return a list of item text / symbol
QgsSymbolV2 * sourceSymbol ()
void setSourceSymbol (QgsSymbolV2 *sym)
QgsVectorColorRampV2 * sourceColorRamp ()
void setSourceColorRamp (QgsVectorColorRampV2 *ramp)
void setRotationField (QString fieldName)
QString rotationField () const
void setSizeScaleField (QString fieldName)
QString sizeScaleField () const

Static Public Member Functions

static QgsFeatureRendererV2 * create (QDomElement &element)
 create renderer from XML element

Protected Member Functions

void rebuildHash ()
QgsSymbolV2 * symbolForValue (QVariant value)

Protected Attributes

QString mAttrName
QgsCategoryList mCategories
QgsSymbolV2 * mSourceSymbol
QgsVectorColorRampV2 * mSourceColorRamp
QString mRotationField
QString mSizeScaleField
int mAttrNum
 attribute index (derived from attribute name in startRender)
int mRotationFieldIdx
int mSizeScaleFieldIdx
QHash< QString, QgsSymbolV2 * > mSymbolHash
 hashtable for faster access to symbols
QHash< QString, QgsSymbolV2 * > mTempSymbols
 temporary symbols, used for data-defined rotation and scaling

Detailed Description

Definition at line 43 of file qgscategorizedsymbolrendererv2.h.

Constructor & Destructor Documentation

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

Definition at line 73 of file qgscategorizedsymbolrendererv2.cpp.

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

Referenced by clone(), and create().

QgsCategorizedSymbolRendererV2::~QgsCategorizedSymbolRendererV2 ( ) [virtual]

Definition at line 94 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, mSourceColorRamp, and mSourceSymbol.

Member Function Documentation

void QgsCategorizedSymbolRendererV2::addCategory ( const QgsRendererCategoryV2 &  category)

Definition at line 214 of file qgscategorizedsymbolrendererv2.cpp.

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

const QgsCategoryList& QgsCategorizedSymbolRendererV2::categories ( ) [inline]

Definition at line 65 of file qgscategorizedsymbolrendererv2.h.

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

int QgsCategorizedSymbolRendererV2::categoryIndexForValue ( QVariant  val)

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

Definition at line 180 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

QString QgsCategorizedSymbolRendererV2::classAttribute ( ) const [inline]

Definition at line 78 of file qgscategorizedsymbolrendererv2.h.

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

QgsFeatureRendererV2 * QgsCategorizedSymbolRendererV2::clone ( ) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 303 of file qgscategorizedsymbolrendererv2.cpp.

References QgsVectorColorRampV2::clone(), QgsSymbolV2::clone(), mAttrName, mCategories, mSourceColorRamp, mSourceSymbol, QgsCategorizedSymbolRendererV2(), rotationField(), setRotationField(), setSizeScaleField(), setSourceColorRamp(), setSourceSymbol(), QgsFeatureRendererV2::setUsingSymbolLevels(), sizeScaleField(), and QgsFeatureRendererV2::usingSymbolLevels().

QgsFeatureRendererV2 * QgsCategorizedSymbolRendererV2::create ( QDomElement &  element) [static]

create renderer from XML element

Definition at line 324 of file qgscategorizedsymbolrendererv2.cpp.

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

Referenced by QgsRendererV2Registry::QgsRendererV2Registry().

void QgsCategorizedSymbolRendererV2::deleteAllCategories ( )

Definition at line 235 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

bool QgsCategorizedSymbolRendererV2::deleteCategory ( int  catIndex)

Definition at line 226 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

QString QgsCategorizedSymbolRendererV2::dump ( ) [virtual]

for debugging

Reimplemented from QgsFeatureRendererV2.

Definition at line 295 of file qgscategorizedsymbolrendererv2.cpp.

References mAttrName, and mCategories.

QgsLegendSymbolList QgsCategorizedSymbolRendererV2::legendSymbolItems ( ) [virtual]

return a list of item text / symbol

Note:
: this method was added in version 1.5

Reimplemented from QgsFeatureRendererV2.

Definition at line 472 of file qgscategorizedsymbolrendererv2.cpp.

References classAttribute(), and mCategories.

QgsLegendSymbologyList QgsCategorizedSymbolRendererV2::legendSymbologyItems ( QSize  iconSize) [virtual]

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

Definition at line 451 of file qgscategorizedsymbolrendererv2.cpp.

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

void QgsCategorizedSymbolRendererV2::rebuildHash ( ) [protected]

Definition at line 101 of file qgscategorizedsymbolrendererv2.cpp.

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

Referenced by startRender().

QString QgsCategorizedSymbolRendererV2::rotationField ( ) const [inline]
Note:
added in 1.6

Definition at line 103 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone().

QDomElement QgsCategorizedSymbolRendererV2::save ( QDomDocument &  doc) [virtual]

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

Definition at line 392 of file qgscategorizedsymbolrendererv2.cpp.

References QgsRendererCategoryV2::label(), mAttrName, mCategories, mRotationField, mSizeScaleField, mSourceColorRamp, mSourceSymbol, QgsFeatureRendererV2::mUsingSymbolLevels, RENDERER_TAG_NAME, QgsSymbolLayerV2Utils::saveColorRamp(), QgsSymbolLayerV2Utils::saveSymbols(), QgsRendererCategoryV2::symbol(), symbols(), and QgsRendererCategoryV2::value().

void QgsCategorizedSymbolRendererV2::setClassAttribute ( QString  attr) [inline]

Definition at line 79 of file qgscategorizedsymbolrendererv2.h.

void QgsCategorizedSymbolRendererV2::setRotationField ( QString  fieldName) [inline]
Note:
added in 1.6

Definition at line 101 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setSizeScaleField ( QString  fieldName) [inline]
Note:
added in 1.6

Definition at line 106 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setSourceColorRamp ( QgsVectorColorRampV2 *  ramp)

Definition at line 506 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceColorRamp.

Referenced by clone(), and create().

void QgsCategorizedSymbolRendererV2::setSourceSymbol ( QgsSymbolV2 *  sym)

Definition at line 496 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceSymbol.

Referenced by clone(), and create().

QString QgsCategorizedSymbolRendererV2::sizeScaleField ( ) const [inline]
Note:
added in 1.6

Definition at line 108 of file qgscategorizedsymbolrendererv2.h.

Referenced by clone().

QgsVectorColorRampV2 * QgsCategorizedSymbolRendererV2::sourceColorRamp ( )

Definition at line 502 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceColorRamp.

QgsSymbolV2 * QgsCategorizedSymbolRendererV2::sourceSymbol ( )

Definition at line 492 of file qgscategorizedsymbolrendererv2.cpp.

References mSourceSymbol.

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

Implements QgsFeatureRendererV2.

Definition at line 240 of file qgscategorizedsymbolrendererv2.cpp.

References QgsSymbolV2::clone(), QgsSymbolV2::DataDefinedRotation, QgsSymbolV2::DataDefinedSizeScale, QgsVectorLayer::fieldNameIndex(), mAttrName, mAttrNum, mCategories, mRotationField, mRotationFieldIdx, mSizeScaleField, mSizeScaleFieldIdx, mTempSymbols, rebuildHash(), QgsSymbolV2::setRenderHints(), and QgsSymbolV2::startRender().

void QgsCategorizedSymbolRendererV2::stopRender ( QgsRenderContext &  context) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 268 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories, and mTempSymbols.

QgsSymbolV2 * QgsCategorizedSymbolRendererV2::symbolForFeature ( QgsFeature &  feature) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 129 of file qgscategorizedsymbolrendererv2.cpp.

References QgsFeature::attributeMap(), QgsSymbolV2::Line, QgsSymbolV2::Marker, mAttrName, mAttrNum, mRotationFieldIdx, mSizeScaleFieldIdx, mTempSymbols, QgsDebugMsg, QgsMarkerSymbolV2::setAngle(), QgsMarkerSymbolV2::setSize(), QgsLineSymbolV2::setWidth(), symbolForValue(), and QgsSymbolV2::type().

QgsSymbolV2 * QgsCategorizedSymbolRendererV2::symbolForValue ( QVariant  value) [protected]

Definition at line 112 of file qgscategorizedsymbolrendererv2.cpp.

References mSymbolHash, and QgsDebugMsg.

Referenced by symbolForFeature().

QgsSymbolV2List QgsCategorizedSymbolRendererV2::symbols ( ) [virtual]

for symbol levels

Implements QgsFeatureRendererV2.

Definition at line 316 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

Referenced by save().

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

Definition at line 206 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

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

Definition at line 198 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

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

Definition at line 190 of file qgscategorizedsymbolrendererv2.cpp.

References mCategories.

QList< QString > QgsCategorizedSymbolRendererV2::usedAttributes ( ) [virtual]

Implements QgsFeatureRendererV2.

Definition at line 284 of file qgscategorizedsymbolrendererv2.cpp.

References mAttrName, mRotationField, and mSizeScaleField.

Member Data Documentation

QString QgsCategorizedSymbolRendererV2::mAttrName [protected]

Definition at line 111 of file qgscategorizedsymbolrendererv2.h.

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

int QgsCategorizedSymbolRendererV2::mAttrNum [protected]

attribute index (derived from attribute name in startRender)

Definition at line 119 of file qgscategorizedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

QgsCategoryList QgsCategorizedSymbolRendererV2::mCategories [protected]

Definition at line 112 of file qgscategorizedsymbolrendererv2.h.

Referenced by addCategory(), categoryIndexForValue(), clone(), deleteAllCategories(), deleteCategory(), dump(), legendSymbolItems(), QgsCategorizedSymbolRendererV2(), rebuildHash(), save(), startRender(), stopRender(), symbols(), updateCategoryLabel(), updateCategorySymbol(), updateCategoryValue(), and ~QgsCategorizedSymbolRendererV2().

QString QgsCategorizedSymbolRendererV2::mRotationField [protected]

Definition at line 115 of file qgscategorizedsymbolrendererv2.h.

Referenced by save(), startRender(), and usedAttributes().

int QgsCategorizedSymbolRendererV2::mRotationFieldIdx [protected]

Definition at line 120 of file qgscategorizedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

QString QgsCategorizedSymbolRendererV2::mSizeScaleField [protected]

Definition at line 116 of file qgscategorizedsymbolrendererv2.h.

Referenced by save(), startRender(), and usedAttributes().

int QgsCategorizedSymbolRendererV2::mSizeScaleFieldIdx [protected]

Definition at line 120 of file qgscategorizedsymbolrendererv2.h.

Referenced by startRender(), and symbolForFeature().

QgsVectorColorRampV2* QgsCategorizedSymbolRendererV2::mSourceColorRamp [protected]

Definition at line 114 of file qgscategorizedsymbolrendererv2.h.

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

QgsSymbolV2* QgsCategorizedSymbolRendererV2::mSourceSymbol [protected]

Definition at line 113 of file qgscategorizedsymbolrendererv2.h.

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

QHash<QString, QgsSymbolV2*> QgsCategorizedSymbolRendererV2::mSymbolHash [protected]

hashtable for faster access to symbols

Definition at line 123 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 126 of file qgscategorizedsymbolrendererv2.h.

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

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Tue Jun 19 2012 23:25:45 for Quantum GIS API Documentation by   doxygen 1.7.6.1