QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Represents an individual category (class) from a QgsCategorizedSymbolRenderer. More...
#include <qgscategorizedsymbolrenderer.h>
Public Member Functions | |
QgsRendererCategory ()=default | |
QgsRendererCategory (const QgsRendererCategory &cat) | |
QgsRendererCategory (const QVariant &value, QgsSymbol *symbol, const QString &label, bool render=true, const QString &uuid=QString()) | |
Constructor for a new QgsRendererCategory, with the specified value and symbol. | |
~QgsRendererCategory () | |
QString | dump () const |
Returns a string representing the categories settings, used for debugging purposes only. | |
QString | label () const |
Returns the label for this category, which is used to represent the category within legends and the layer tree. | |
QgsRendererCategory & | operator= (QgsRendererCategory cat) |
bool | renderState () const |
Returns true if the category is currently enabled and should be rendered. | |
void | setLabel (const QString &label) |
Sets the label for this category, which is used to represent the category within legends and the layer tree. | |
void | setRenderState (bool render) |
Sets whether the category is currently enabled and should be rendered. | |
void | setSymbol (QgsSymbol *s) |
Sets the symbol which will be used to render this category. | |
void | setValue (const QVariant &value) |
Sets the value corresponding to this category. | |
QgsSymbol * | symbol () const |
Returns the symbol which will be used to render this category. | |
void | toSld (QDomDocument &doc, QDomElement &element, QVariantMap props) const |
Converts the category to a matching SLD rule, within the specified DOM document and element. | |
QString | uuid () const |
Returns the unique identifier for this category. | |
QVariant | value () const |
Returns the value corresponding to this category. | |
Protected Attributes | |
QString | mLabel |
bool | mRender = true |
std::unique_ptr< QgsSymbol > | mSymbol |
QString | mUuid |
QVariant | mValue |
Represents an individual category (class) from a QgsCategorizedSymbolRenderer.
Definition at line 35 of file qgscategorizedsymbolrenderer.h.
|
default |
QgsRendererCategory::QgsRendererCategory | ( | const QVariant & | value, |
QgsSymbol * | symbol, | ||
const QString & | label, | ||
bool | render = true , |
||
const QString & | uuid = QString() |
||
) |
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.
The optional uuid argument manually set the UUID key identifier for the category (since QGIS 3.34).
Definition at line 49 of file qgscategorizedsymbolrenderer.cpp.
QgsRendererCategory::QgsRendererCategory | ( | const QgsRendererCategory & | cat | ) |
Definition at line 58 of file qgscategorizedsymbolrenderer.cpp.
|
default |
QString QgsRendererCategory::dump | ( | ) | const |
Returns a string representing the categories settings, used for debugging purposes only.
Definition at line 124 of file qgscategorizedsymbolrenderer.cpp.
QString QgsRendererCategory::label | ( | ) | const |
Returns the label for this category, which is used to represent the category within legends and the layer tree.
Definition at line 94 of file qgscategorizedsymbolrenderer.cpp.
QgsRendererCategory & QgsRendererCategory::operator= | ( | QgsRendererCategory | cat | ) |
Definition at line 67 of file qgscategorizedsymbolrenderer.cpp.
bool QgsRendererCategory::renderState | ( | ) | const |
Returns true
if the category is currently enabled and should be rendered.
Definition at line 99 of file qgscategorizedsymbolrenderer.cpp.
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.
Definition at line 114 of file qgscategorizedsymbolrenderer.cpp.
void QgsRendererCategory::setRenderState | ( | bool | render | ) |
Sets whether the category is currently enabled and should be rendered.
Definition at line 119 of file qgscategorizedsymbolrenderer.cpp.
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.
Definition at line 109 of file qgscategorizedsymbolrenderer.cpp.
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.
Definition at line 104 of file qgscategorizedsymbolrenderer.cpp.
QgsSymbol * QgsRendererCategory::symbol | ( | ) | const |
Returns the symbol which will be used to render this category.
Definition at line 89 of file qgscategorizedsymbolrenderer.cpp.
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 129 of file qgscategorizedsymbolrenderer.cpp.
QString QgsRendererCategory::uuid | ( | ) | const |
Returns the unique identifier for this category.
Definition at line 79 of file qgscategorizedsymbolrenderer.cpp.
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.
Definition at line 84 of file qgscategorizedsymbolrenderer.cpp.
|
protected |
Definition at line 152 of file qgscategorizedsymbolrenderer.h.
|
protected |
Definition at line 153 of file qgscategorizedsymbolrenderer.h.
|
protected |
Definition at line 151 of file qgscategorizedsymbolrenderer.h.
|
protected |
Definition at line 154 of file qgscategorizedsymbolrenderer.h.
|
protected |
Definition at line 150 of file qgscategorizedsymbolrenderer.h.