QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsCategorizedSymbolRenderer Class Reference

#include <qgscategorizedsymbolrenderer.h>

Inheritance diagram for QgsCategorizedSymbolRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsCategorizedSymbolRenderer (const QString &attrName=QString(), const QgsCategoryList &categories=QgsCategoryList())
 
void addCategory (const QgsRendererCategory &category)
 
QgsFeatureRenderer::Capabilities capabilities () override
 Returns details about internals of this renderer. More...
 
const QgsCategoryListcategories () const
 
int categoryIndexForLabel (const QString &val)
 Returns index of category with specified label (-1 if not found or not unique) More...
 
int categoryIndexForValue (const QVariant &val)
 Returns index of category with specified value (-1 if not found) More...
 
void checkLegendSymbolItem (const QString &key, bool state=true) override
 item in symbology was checked More...
 
QString classAttribute () const
 
QgsCategorizedSymbolRendererclone () const override
 Create a deep copy of this renderer. More...
 
QgsDataDefinedSizeLegenddataDefinedSizeLegend () const
 Returns configuration of appearance of legend when using data-defined size for marker symbols. More...
 
void deleteAllCategories ()
 
bool deleteCategory (int catIndex)
 
QString dump () const override
 Returns debug information about this renderer. More...
 
QString filter (const QgsFields &fields=QgsFields()) override
 If a renderer does not require all the features this method may be overridden and return an expression used as where clause. More...
 
QString legendClassificationAttribute () const override
 If supported by the renderer, return classification attribute for the use in legend. More...
 
QSet< QString > legendKeysForFeature (const QgsFeature &feature, QgsRenderContext &context) const override
 Returns legend keys matching a specified feature. More...
 
bool legendSymbolItemChecked (const QString &key) override
 items of symbology items in legend is checked More...
 
QgsLegendSymbolList legendSymbolItems () const override
 Returns a list of symbology items for the legend. More...
 
bool legendSymbolItemsCheckable () const override
 items of symbology items in legend should be checkable More...
 
void moveCategory (int from, int to)
 Moves the category at index position from to index position to. More...
 
QgsSymboloriginalSymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override
 Returns symbol for feature. More...
 
QDomElement save (QDomDocument &doc, const QgsReadWriteContext &context) override
 store renderer info to XML element More...
 
void setClassAttribute (const QString &attr)
 
void setDataDefinedSizeLegend (QgsDataDefinedSizeLegend *settings)
 Configures appearance of legend when renderer is configured to use data-defined size for marker symbols. More...
 
void setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override
 Sets the symbol to be used for a legend symbol item. More...
 
void setSourceColorRamp (QgsColorRamp *ramp)
 Sets the source color ramp. More...
 
void setSourceSymbol (QgsSymbol *sym)
 Sets the source symbol for the renderer, which is the base symbol used for the each categories' symbol before applying the categories' color. More...
 
void sortByLabel (Qt::SortOrder order=Qt::AscendingOrder)
 
void sortByValue (Qt::SortOrder order=Qt::AscendingOrder)
 
QgsColorRampsourceColorRamp ()
 Returns the source color ramp, from which each categories' color is derived. More...
 
QgsSymbolsourceSymbol ()
 Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying the categories' color. More...
 
void startRender (QgsRenderContext &context, const QgsFields &fields) override
 Must be called when a new render cycle is started. More...
 
void stopRender (QgsRenderContext &context) override
 Must be called when a render cycle has finished, to allow the renderer to clean up. More...
 
QgsSymbolsymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override
 To be overridden. More...
 
QgsSymbolList symbols (QgsRenderContext &context) const override
 Returns list of symbols used by the renderer. More...
 
void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) const override
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
bool updateCategoryLabel (int catIndex, const QString &label)
 
bool updateCategoryRenderState (int catIndex, bool render)
 
bool updateCategorySymbol (int catIndex, QgsSymbol *symbol)
 
bool updateCategoryValue (int catIndex, const QVariant &value)
 
void updateColorRamp (QgsColorRamp *ramp)
 Update the color ramp used and all symbols colors. More...
 
void updateSymbols (QgsSymbol *sym)
 Update all the symbols but leave categories and colors. More...
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns a list of attributes required by this renderer. More...
 
- Public Member Functions inherited from QgsFeatureRenderer
virtual ~QgsFeatureRenderer ()
 
virtual const QgsFeatureRendererembeddedRenderer () const
 Returns the current embedded renderer (subrenderer) for this feature renderer. More...
 
virtual bool filterNeedsGeometry () const
 Returns true if this renderer requires the geometry to apply the filter. More...
 
bool forceRasterRender () const
 Returns whether the renderer must render as a raster. More...
 
virtual void modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context)
 Allows for a renderer to modify the extent of a feature request prior to rendering. More...
 
QgsFeatureRequest::OrderBy orderBy () const
 Gets the order in which features shall be processed by this renderer. More...
 
bool orderByEnabled () const
 Returns whether custom ordering will be applied before features are processed by this renderer. More...
 
virtual QgsSymbolList originalSymbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const
 Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the renderer. More...
 
virtual bool renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
 Render a feature using this renderer in the given context. More...
 
virtual void setEmbeddedRenderer (QgsFeatureRenderer *subRenderer)
 Sets an embedded renderer (subrenderer) for this feature renderer. More...
 
void setForceRasterRender (bool forceRaster)
 Sets whether the renderer should be rendered to a raster destination. More...
 
void setOrderBy (const QgsFeatureRequest::OrderBy &orderBy)
 Define the order in which features shall be processed by this renderer. More...
 
void setOrderByEnabled (bool enabled)
 Sets whether custom ordering should be applied before features are processed by this renderer. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the renderer. More...
 
void setUsingSymbolLevels (bool usingSymbolLevels)
 
void setVertexMarkerAppearance (int type, int size)
 Sets type and size of editing vertex markers for subsequent rendering. More...
 
virtual QgsSymbolList symbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const
 Returns list of symbols used for rendering the feature. More...
 
QString type () const
 
bool usingSymbolLevels () const
 
virtual bool willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const
 Returns whether the renderer will render a feature or not. More...
 
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName, const QgsStringMap &props=QgsStringMap()) const
 create the SLD UserStyle element following the SLD v1.1 specs with the given name More...
 

Static Public Member Functions

static QgsCategorizedSymbolRendererconvertFromRenderer (const QgsFeatureRenderer *renderer)
 creates a QgsCategorizedSymbolRenderer from an existing renderer. More...
 
static QgsFeatureRenderercreate (QDomElement &element, const QgsReadWriteContext &context)
 create renderer from XML element More...
 
- Static Public Member Functions inherited from QgsFeatureRenderer
static QgsFeatureRendererdefaultRenderer (QgsWkbTypes::GeometryType geomType)
 Returns a new renderer - used by default in vector layers. More...
 
static QgsFeatureRendererload (QDomElement &symbologyElem, const QgsReadWriteContext &context)
 create a renderer from XML element More...
 
static QgsFeatureRendererloadSld (const QDomNode &node, QgsWkbTypes::GeometryType geomType, QString &errorMessage)
 Create a new renderer according to the information contained in the UserStyle element of a SLD style document. More...
 

Protected Member Functions

void rebuildHash ()
 
Q_DECL_DEPRECATED QgsSymbolskipRender ()
 
Q_DECL_DEPRECATED QgsSymbolsymbolForValue (const QVariant &value) const
 Returns the matching symbol corresponding to an attribute value. More...
 
QgsSymbolsymbolForValue (const QVariant &value, bool &foundMatchingSymbol) const
 Returns the matching symbol corresponding to an attribute value. More...
 
- Protected Member Functions inherited from QgsFeatureRenderer
 QgsFeatureRenderer (const QString &type)
 
void copyRendererData (QgsFeatureRenderer *destRenderer) const
 Clones generic renderer data to another renderer. More...
 
void renderFeatureWithSymbol (const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
 Render the feature with the symbol using context. More...
 
void renderVertexMarker (QPointF pt, QgsRenderContext &context)
 render editing vertex marker at specified point More...
 
void renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
 render editing vertex marker for a polygon More...
 
void renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
 render editing vertex marker for a polyline More...
 

Protected Attributes

QString mAttrName
 
int mAttrNum = -1
 attribute index (derived from attribute name in startRender) More...
 
QgsCategoryList mCategories
 
bool mCounting = false
 
std::unique_ptr< QgsDataDefinedSizeLegendmDataDefinedSizeLegend
 
std::unique_ptr< QgsExpressionmExpression
 
std::unique_ptr< QgsColorRampmSourceColorRamp
 
std::unique_ptr< QgsSymbolmSourceSymbol
 
QHash< QString, QgsSymbol * > mSymbolHash
 hashtable for faster access to symbols More...
 
- Protected Attributes inherited from QgsFeatureRenderer
int mCurrentVertexMarkerSize
 The current size of editing marker. More...
 
int mCurrentVertexMarkerType
 The current type of editing marker. More...
 
bool mForceRaster
 
QgsFeatureRequest::OrderBy mOrderBy
 
bool mOrderByEnabled
 
QgsPaintEffectmPaintEffect = nullptr
 
QString mType
 
bool mUsingSymbolLevels
 

Additional Inherited Members

- Public Types inherited from QgsFeatureRenderer
enum  Capability { SymbolLevels = 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 }
 Used to specify details about a renderer. More...
 
- Static Protected Member Functions inherited from QgsFeatureRenderer
static QPointF _getPoint (QgsRenderContext &context, const QgsPoint &point)
 Creates a point in screen coordinates from a wkb string in map coordinates. More...
 
static void convertSymbolRotation (QgsSymbol *symbol, const QString &field)
 
static void convertSymbolSizeScale (QgsSymbol *symbol, QgsSymbol::ScaleMethod method, const QString &field)
 

Detailed Description

Definition at line 93 of file qgscategorizedsymbolrenderer.h.

Constructor & Destructor Documentation

◆ QgsCategorizedSymbolRenderer()

QgsCategorizedSymbolRenderer::QgsCategorizedSymbolRenderer ( const QString &  attrName = QString(),
const QgsCategoryList categories = QgsCategoryList() 
)

Definition at line 158 of file qgscategorizedsymbolrenderer.cpp.

Member Function Documentation

◆ addCategory()

void QgsCategorizedSymbolRenderer::addCategory ( const QgsRendererCategory category)

Definition at line 320 of file qgscategorizedsymbolrenderer.cpp.

◆ capabilities()

QgsFeatureRenderer::Capabilities QgsCategorizedSymbolRenderer::capabilities ( )
inlineoverridevirtual

Returns details about internals of this renderer.

E.g. if you only want to deal with visible features:

if not renderer.capabilities().testFlag(QgsFeatureRenderer.Filter) or renderer.willRenderFeature(feature, context):
deal_with_my_feature()
else:
skip_the_curren_feature()

Reimplemented from QgsFeatureRenderer.

Definition at line 107 of file qgscategorizedsymbolrenderer.h.

◆ categories()

const QgsCategoryList& QgsCategorizedSymbolRenderer::categories ( ) const
inline

Definition at line 119 of file qgscategorizedsymbolrenderer.h.

◆ categoryIndexForLabel()

int QgsCategorizedSymbolRenderer::categoryIndexForLabel ( const QString &  val)

Returns index of category with specified label (-1 if not found or not unique)

Since
QGIS 2.5

Definition at line 272 of file qgscategorizedsymbolrenderer.cpp.

◆ categoryIndexForValue()

int QgsCategorizedSymbolRenderer::categoryIndexForValue ( const QVariant &  val)

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

Definition at line 262 of file qgscategorizedsymbolrenderer.cpp.

◆ checkLegendSymbolItem()

void QgsCategorizedSymbolRenderer::checkLegendSymbolItem ( const QString &  key,
bool  state = true 
)
overridevirtual

item in symbology was checked

Since
QGIS 2.5

Reimplemented from QgsFeatureRenderer.

Definition at line 902 of file qgscategorizedsymbolrenderer.cpp.

◆ classAttribute()

QString QgsCategorizedSymbolRenderer::classAttribute ( ) const
inline

Definition at line 147 of file qgscategorizedsymbolrenderer.h.

◆ clone()

QgsCategorizedSymbolRenderer * QgsCategorizedSymbolRenderer::clone ( ) const
overridevirtual

Create a deep copy of this renderer.

Should be implemented by all subclasses and generate a proper subclass.

Returns
A copy of this renderer

Implements QgsFeatureRenderer.

Definition at line 462 of file qgscategorizedsymbolrenderer.cpp.

◆ convertFromRenderer()

QgsCategorizedSymbolRenderer * QgsCategorizedSymbolRenderer::convertFromRenderer ( const QgsFeatureRenderer renderer)
static

creates a QgsCategorizedSymbolRenderer from an existing renderer.

Returns
a new renderer if the conversion was possible, otherwise 0.
Since
QGIS 2.5

Definition at line 910 of file qgscategorizedsymbolrenderer.cpp.

◆ create()

QgsFeatureRenderer * QgsCategorizedSymbolRenderer::create ( QDomElement &  element,
const QgsReadWriteContext context 
)
static

create renderer from XML element

Definition at line 573 of file qgscategorizedsymbolrenderer.cpp.

◆ dataDefinedSizeLegend()

QgsDataDefinedSizeLegend * QgsCategorizedSymbolRenderer::dataDefinedSizeLegend ( ) const

Returns configuration of appearance of legend when using data-defined size for marker symbols.

Will return null if the functionality is disabled.

Since
QGIS 3.0

Definition at line 955 of file qgscategorizedsymbolrenderer.cpp.

◆ deleteAllCategories()

void QgsCategorizedSymbolRenderer::deleteAllCategories ( )

Definition at line 340 of file qgscategorizedsymbolrenderer.cpp.

◆ deleteCategory()

bool QgsCategorizedSymbolRenderer::deleteCategory ( int  catIndex)

Definition at line 331 of file qgscategorizedsymbolrenderer.cpp.

◆ dump()

QString QgsCategorizedSymbolRenderer::dump ( ) const
overridevirtual

Returns debug information about this renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 454 of file qgscategorizedsymbolrenderer.cpp.

◆ filter()

QString QgsCategorizedSymbolRenderer::filter ( const QgsFields fields = QgsFields())
overridevirtual

If a renderer does not require all the features this method may be overridden and return an expression used as where clause.

This will be called once after startRender() and before the first call to renderFeature(). By default this returns a null string and all features will be requested. You do not need to specify the extent in here, this is taken care of separately and will be combined with a filter returned from this method.

Returns
An expression used as where clause

Reimplemented from QgsFeatureRenderer.

Definition at line 490 of file qgscategorizedsymbolrenderer.cpp.

◆ legendClassificationAttribute()

QString QgsCategorizedSymbolRenderer::legendClassificationAttribute ( ) const
inlineoverridevirtual

If supported by the renderer, return classification attribute for the use in legend.

Since
QGIS 2.6

Reimplemented from QgsFeatureRenderer.

Definition at line 200 of file qgscategorizedsymbolrenderer.h.

◆ legendKeysForFeature()

QSet< QString > QgsCategorizedSymbolRenderer::legendKeysForFeature ( const QgsFeature feature,
QgsRenderContext context 
) const
overridevirtual

Returns legend keys matching a specified feature.

Since
QGIS 2.14

Reimplemented from QgsFeatureRenderer.

Definition at line 803 of file qgscategorizedsymbolrenderer.cpp.

◆ legendSymbolItemChecked()

bool QgsCategorizedSymbolRenderer::legendSymbolItemChecked ( const QString &  key)
overridevirtual

items of symbology items in legend is checked

Since
QGIS 2.5

Reimplemented from QgsFeatureRenderer.

Definition at line 882 of file qgscategorizedsymbolrenderer.cpp.

◆ legendSymbolItems()

QgsLegendSymbolList QgsCategorizedSymbolRenderer::legendSymbolItems ( ) const
overridevirtual

Returns a list of symbology items for the legend.

Since
QGIS 2.6

Reimplemented from QgsFeatureRenderer.

Definition at line 763 of file qgscategorizedsymbolrenderer.cpp.

◆ legendSymbolItemsCheckable()

bool QgsCategorizedSymbolRenderer::legendSymbolItemsCheckable ( ) const
overridevirtual

items of symbology items in legend should be checkable

Since
QGIS 2.5

Reimplemented from QgsFeatureRenderer.

Definition at line 877 of file qgscategorizedsymbolrenderer.cpp.

◆ moveCategory()

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

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

Definition at line 345 of file qgscategorizedsymbolrenderer.cpp.

◆ originalSymbolForFeature()

QgsSymbol * QgsCategorizedSymbolRenderer::originalSymbolForFeature ( const QgsFeature feature,
QgsRenderContext context 
) const
overridevirtual

Returns 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.

Since
QGIS 2.12

Reimplemented from QgsFeatureRenderer.

Definition at line 244 of file qgscategorizedsymbolrenderer.cpp.

◆ rebuildHash()

void QgsCategorizedSymbolRenderer::rebuildHash ( )
protected

Definition at line 175 of file qgscategorizedsymbolrenderer.cpp.

◆ save()

QDomElement QgsCategorizedSymbolRenderer::save ( QDomDocument &  doc,
const QgsReadWriteContext context 
)
overridevirtual

store renderer info to XML element

Reimplemented from QgsFeatureRenderer.

Definition at line 670 of file qgscategorizedsymbolrenderer.cpp.

◆ setClassAttribute()

void QgsCategorizedSymbolRenderer::setClassAttribute ( const QString &  attr)
inline

Definition at line 148 of file qgscategorizedsymbolrenderer.h.

◆ setDataDefinedSizeLegend()

void QgsCategorizedSymbolRenderer::setDataDefinedSizeLegend ( QgsDataDefinedSizeLegend settings)

Configures appearance of legend when renderer is configured to use data-defined size for marker symbols.

This allows configuring for which values (symbol sizes) should be shown in the legend, whether to display different symbol sizes collapsed in one legend node or separated across multiple legend nodes etc.

When renderer does not use data-defined size or does not use marker symbols, these settings will be ignored. Takes ownership of the passed settings objects. Null pointer is a valid input that disables data-defined size legend.

Since
QGIS 3.0

Definition at line 950 of file qgscategorizedsymbolrenderer.cpp.

◆ setLegendSymbolItem()

void QgsCategorizedSymbolRenderer::setLegendSymbolItem ( const QString &  key,
QgsSymbol symbol 
)
overridevirtual

Sets the symbol to be used for a legend symbol item.

Parameters
keyrule key for legend symbol
symbolnew symbol for legend item. Ownership is transferred to renderer.
Since
QGIS 2.14

Reimplemented from QgsFeatureRenderer.

Definition at line 892 of file qgscategorizedsymbolrenderer.cpp.

◆ setSourceColorRamp()

void QgsCategorizedSymbolRenderer::setSourceColorRamp ( QgsColorRamp ramp)

Sets the source color ramp.

Parameters
rampcolor ramp. Ownership is transferred to the renderer
See also
sourceColorRamp()
setSourceSymbol()

Definition at line 837 of file qgscategorizedsymbolrenderer.cpp.

◆ setSourceSymbol()

void QgsCategorizedSymbolRenderer::setSourceSymbol ( QgsSymbol sym)

Sets the source symbol for the renderer, which is the base symbol used for the each categories' symbol before applying the categories' color.

Parameters
symsource symbol, ownership is transferred to the renderer
See also
sourceSymbol()
setSourceColorRamp()

Definition at line 827 of file qgscategorizedsymbolrenderer.cpp.

◆ skipRender()

QgsSymbol * QgsCategorizedSymbolRenderer::skipRender ( )
protected
Deprecated:
No longer used, will be removed in QGIS 4.0

Definition at line 186 of file qgscategorizedsymbolrenderer.cpp.

◆ sortByLabel()

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

Definition at line 382 of file qgscategorizedsymbolrenderer.cpp.

◆ sortByValue()

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

Definition at line 360 of file qgscategorizedsymbolrenderer.cpp.

◆ sourceColorRamp()

QgsColorRamp * QgsCategorizedSymbolRenderer::sourceColorRamp ( )

Returns the source color ramp, from which each categories' color is derived.

See also
setSourceColorRamp()
sourceSymbol()

Definition at line 832 of file qgscategorizedsymbolrenderer.cpp.

◆ sourceSymbol()

QgsSymbol * QgsCategorizedSymbolRenderer::sourceSymbol ( )

Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying the categories' color.

See also
setSourceSymbol()
sourceColorRamp()

Definition at line 823 of file qgscategorizedsymbolrenderer.cpp.

◆ startRender()

void QgsCategorizedSymbolRenderer::startRender ( QgsRenderContext context,
const QgsFields fields 
)
overridevirtual

Must be called when a new render cycle is started.

A call to startRender() must always be followed by a corresponding call to stopRender() after all features have been rendered.

Parameters
contextAdditional information passed to the renderer about the job which will be rendered
fieldsThe fields available for rendering
See also
stopRender()
Warning
This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.

Reimplemented from QgsFeatureRenderer.

Definition at line 394 of file qgscategorizedsymbolrenderer.cpp.

◆ stopRender()

void QgsCategorizedSymbolRenderer::stopRender ( QgsRenderContext context)
overridevirtual

Must be called when a render cycle has finished, to allow the renderer to clean up.

Calls to stopRender() must always be preceded by a call to startRender().

Warning
This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.
See also
startRender()

Reimplemented from QgsFeatureRenderer.

Definition at line 417 of file qgscategorizedsymbolrenderer.cpp.

◆ symbolForFeature()

QgsSymbol * QgsCategorizedSymbolRenderer::symbolForFeature ( const QgsFeature feature,
QgsRenderContext context 
) const
overridevirtual

To be overridden.

Must be called between startRender() and stopRender() calls.

Parameters
featurefeature
contextrender context
Returns
returns pointer to symbol or 0 if symbol was not found
Since
QGIS 2.12

Implements QgsFeatureRenderer.

Definition at line 221 of file qgscategorizedsymbolrenderer.cpp.

◆ symbolForValue() [1/2]

QgsSymbol * QgsCategorizedSymbolRenderer::symbolForValue ( const QVariant &  value) const
protected

Returns the matching symbol corresponding to an attribute value.

Deprecated:
use variant which takes a second bool argument instead.

Definition at line 191 of file qgscategorizedsymbolrenderer.cpp.

◆ symbolForValue() [2/2]

QgsSymbol * QgsCategorizedSymbolRenderer::symbolForValue ( const QVariant &  value,
bool &  foundMatchingSymbol 
) const
protected

Returns the matching symbol corresponding to an attribute value.

Will return nullptr if no matching symbol was found for value, or if the category corresponding to value is currently disabled (see QgsRendererCategory::renderState()).

If foundMatchingSymbol is specified then it will be set to true if a matching category was found. This can be used to differentiate between a nullptr returned as a result of no matching category vs a nullptr as a result of disabled categories.

Note
available in Python bindings as symbolForValue2

Definition at line 197 of file qgscategorizedsymbolrenderer.cpp.

◆ symbols()

QgsSymbolList QgsCategorizedSymbolRenderer::symbols ( QgsRenderContext context) const
overridevirtual

Returns list of symbols used by the renderer.

Parameters
contextrender context
Since
QGIS 2.12

Reimplemented from QgsFeatureRenderer.

Definition at line 561 of file qgscategorizedsymbolrenderer.cpp.

◆ toSld()

void QgsCategorizedSymbolRenderer::toSld ( QDomDocument &  doc,
QDomElement &  element,
const QgsStringMap props = QgsStringMap() 
) const
overridevirtual

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

Reimplemented from QgsFeatureRenderer.

Definition at line 478 of file qgscategorizedsymbolrenderer.cpp.

◆ updateCategoryLabel()

bool QgsCategorizedSymbolRenderer::updateCategoryLabel ( int  catIndex,
const QString &  label 
)

Definition at line 304 of file qgscategorizedsymbolrenderer.cpp.

◆ updateCategoryRenderState()

bool QgsCategorizedSymbolRenderer::updateCategoryRenderState ( int  catIndex,
bool  render 
)
Since
QGIS 2.5

Definition at line 312 of file qgscategorizedsymbolrenderer.cpp.

◆ updateCategorySymbol()

bool QgsCategorizedSymbolRenderer::updateCategorySymbol ( int  catIndex,
QgsSymbol symbol 
)

Definition at line 296 of file qgscategorizedsymbolrenderer.cpp.

◆ updateCategoryValue()

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

Definition at line 288 of file qgscategorizedsymbolrenderer.cpp.

◆ updateColorRamp()

void QgsCategorizedSymbolRenderer::updateColorRamp ( QgsColorRamp ramp)

Update the color ramp used and all symbols colors.

Parameters
rampcolor ramp. Ownership is transferred to the renderer
Since
QGIS 2.5

Definition at line 842 of file qgscategorizedsymbolrenderer.cpp.

◆ updateSymbols()

void QgsCategorizedSymbolRenderer::updateSymbols ( QgsSymbol sym)

Update all the symbols but leave categories and colors.

This method also sets the source symbol for the renderer.

Parameters
symsource symbol to use for categories. Ownership is not transferred.
See also
setSourceSymbol()

Definition at line 864 of file qgscategorizedsymbolrenderer.cpp.

◆ usedAttributes()

QSet< QString > QgsCategorizedSymbolRenderer::usedAttributes ( const QgsRenderContext context) const
overridevirtual

Returns a list of attributes required by this renderer.

Attributes not listed in here may not have been requested from the provider at rendering time.

Returns
A set of attributes

Implements QgsFeatureRenderer.

Definition at line 428 of file qgscategorizedsymbolrenderer.cpp.

Member Data Documentation

◆ mAttrName

QString QgsCategorizedSymbolRenderer::mAttrName
protected

Definition at line 229 of file qgscategorizedsymbolrenderer.h.

◆ mAttrNum

int QgsCategorizedSymbolRenderer::mAttrNum = -1
protected

attribute index (derived from attribute name in startRender)

Definition at line 238 of file qgscategorizedsymbolrenderer.h.

◆ mCategories

QgsCategoryList QgsCategorizedSymbolRenderer::mCategories
protected

Definition at line 230 of file qgscategorizedsymbolrenderer.h.

◆ mCounting

bool QgsCategorizedSymbolRenderer::mCounting = false
protected

Definition at line 242 of file qgscategorizedsymbolrenderer.h.

◆ mDataDefinedSizeLegend

std::unique_ptr<QgsDataDefinedSizeLegend> QgsCategorizedSymbolRenderer::mDataDefinedSizeLegend
protected

Definition at line 235 of file qgscategorizedsymbolrenderer.h.

◆ mExpression

std::unique_ptr<QgsExpression> QgsCategorizedSymbolRenderer::mExpression
protected

Definition at line 233 of file qgscategorizedsymbolrenderer.h.

◆ mSourceColorRamp

std::unique_ptr<QgsColorRamp> QgsCategorizedSymbolRenderer::mSourceColorRamp
protected

Definition at line 232 of file qgscategorizedsymbolrenderer.h.

◆ mSourceSymbol

std::unique_ptr<QgsSymbol> QgsCategorizedSymbolRenderer::mSourceSymbol
protected

Definition at line 231 of file qgscategorizedsymbolrenderer.h.

◆ mSymbolHash

QHash<QString, QgsSymbol *> QgsCategorizedSymbolRenderer::mSymbolHash
protected

hashtable for faster access to symbols

Definition at line 241 of file qgscategorizedsymbolrenderer.h.


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