QgsRendererCategory Class Reference

Represents an individual category (class) from a QgsCategorizedSymbolRenderer. More...

#include <qgscategorizedsymbolrenderer.h>

Public Member Functions
	QgsRendererCategory ()=default
	Constructor for QgsRendererCategory. More...
	QgsRendererCategory (const QgsRendererCategory &cat)
	Copy constructor. More...
	QgsRendererCategory (const QVariant &value, QgsSymbol *symbol, const QString &label, bool render=true)
	Constructor for a new QgsRendererCategory, with the specified value and symbol. More...
	~QgsRendererCategory ()
QString	dump () const
	Returns a string representing the categories settings, used for debugging purposes only. More...
QString	label () const
	Returns the label for this category, which is used to represent the category within legends and the layer tree. More...
QgsRendererCategory &	operator= (QgsRendererCategory cat)
bool	renderState () const
	Returns true if the category is currently enabled and should be rendered. More...
void	setLabel (const QString &label)
	Sets the label for this category, which is used to represent the category within legends and the layer tree. More...
void	setRenderState (bool render)
	Sets whether the category is currently enabled and should be rendered. More...
void	setSymbol (QgsSymbol *s)
	Sets the symbol which will be used to render this category. More...
void	setValue (const QVariant &value)
	Sets the value corresponding to this category. More...
QgsSymbol *	symbol () const
	Returns the symbol which will be used to render this category. More...
void	toSld (QDomDocument &doc, QDomElement &element, QVariantMap props) const
	Converts the category to a matching SLD rule, within the specified DOM document and element. More...
QVariant	value () const
	Returns the value corresponding to this category. More...

Protected Member Functions
void	swap (QgsRendererCategory &other)

Protected Attributes
QString	mLabel
bool	mRender = true
std::unique_ptr< QgsSymbol >	mSymbol
QVariant	mValue

Detailed Description

Represents an individual category (class) from a QgsCategorizedSymbolRenderer.

Definition at line 35 of file qgscategorizedsymbolrenderer.h.

Constructor & Destructor Documentation

QgsRendererCategory() [1/3]

QgsRendererCategory::QgsRendererCategory ( )

default

Constructor for QgsRendererCategory.

QgsRendererCategory() [2/3]

QgsRendererCategory::QgsRendererCategory	(	const QVariant &	value,
		QgsSymbol *	symbol,
		const QString &	label,
		bool	render = true
	)

Constructor for a new QgsRendererCategory, with the specified value and symbol.

If value is a list, then the category will match any of the values from this list.

The ownership of symbol is transferred to the category.

The label argument specifies the label used for this category in legends and the layer tree.

The render argument indicates whether the category should initially be rendered and appear checked in the layer tree.

Definition at line 48 of file qgscategorizedsymbolrenderer.cpp.

QgsRendererCategory() [3/3]

QgsRendererCategory::QgsRendererCategory

(

const QgsRendererCategory &

cat

)

Copy constructor.

Definition at line 56 of file qgscategorizedsymbolrenderer.cpp.

~QgsRendererCategory()

QgsRendererCategory::~QgsRendererCategory ( )

default

Member Function Documentation

dump()

QString QgsRendererCategory::dump

(

)

const

Returns a string representing the categories settings, used for debugging purposes only.

Definition at line 120 of file qgscategorizedsymbolrenderer.cpp.

label()

QString QgsRendererCategory::label

(

)

const

Returns the label for this category, which is used to represent the category within legends and the layer tree.

See also

setLabel()

Definition at line 90 of file qgscategorizedsymbolrenderer.cpp.

operator=()

QgsRendererCategory & QgsRendererCategory::operator=

(

QgsRendererCategory

cat

)

Definition at line 65 of file qgscategorizedsymbolrenderer.cpp.

renderState()

bool QgsRendererCategory::renderState

(

)

const

Returns true if the category is currently enabled and should be rendered.

See also

setRenderState()

Since

QGIS 2.5

Definition at line 95 of file qgscategorizedsymbolrenderer.cpp.

setLabel()

void QgsRendererCategory::setLabel

(

const QString &

label

)

Sets the label for this category, which is used to represent the category within legends and the layer tree.

See also

label()

Definition at line 110 of file qgscategorizedsymbolrenderer.cpp.

setRenderState()

void QgsRendererCategory::setRenderState

(

bool

render

)

Sets whether the category is currently enabled and should be rendered.

See also

renderState()

Since

QGIS 2.5

Definition at line 115 of file qgscategorizedsymbolrenderer.cpp.

setSymbol()

void QgsRendererCategory::setSymbol

(

QgsSymbol *

s

)

Sets the symbol which will be used to render this category.

Ownership of the symbol is transferred to the category.

See also

symbol()

Definition at line 105 of file qgscategorizedsymbolrenderer.cpp.

setValue()

void QgsRendererCategory::setValue

(

const QVariant &

value

)

Sets the value corresponding to this category.

If value is a list, then the category will match any of the values from this list.

See also

value()

Definition at line 100 of file qgscategorizedsymbolrenderer.cpp.

swap()

void QgsRendererCategory::swap ( QgsRendererCategory &  other )

protected

Definition at line 73 of file qgscategorizedsymbolrenderer.cpp.

symbol()

QgsSymbol * QgsRendererCategory::symbol

(

)

const

Returns the symbol which will be used to render this category.

See also

setSymbol()

Definition at line 85 of file qgscategorizedsymbolrenderer.cpp.

toSld()

void QgsRendererCategory::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		QVariantMap	props
	)		const

Converts the category to a matching SLD rule, within the specified DOM document and element.

Definition at line 125 of file qgscategorizedsymbolrenderer.cpp.

value()

QVariant QgsRendererCategory::value

(

)

const

Returns the value corresponding to this category.

If the returned value is a list, then the category will match any of the values from this list.

See also

setValue()

Definition at line 80 of file qgscategorizedsymbolrenderer.cpp.

Member Data Documentation

mLabel

QString QgsRendererCategory::mLabel

protected

Definition at line 152 of file qgscategorizedsymbolrenderer.h.

mRender

bool QgsRendererCategory::mRender = true

protected

Definition at line 153 of file qgscategorizedsymbolrenderer.h.

mSymbol

std::unique_ptr<QgsSymbol> QgsRendererCategory::mSymbol

protected

Definition at line 151 of file qgscategorizedsymbolrenderer.h.

mValue

QVariant QgsRendererCategory::mValue

protected

Definition at line 150 of file qgscategorizedsymbolrenderer.h.

---

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

• /build/qgis-3.28.0+99sid/src/core/symbology/qgscategorizedsymbolrenderer.h
• /build/qgis-3.28.0+99sid/src/core/symbology/qgscategorizedsymbolrenderer.cpp