QGIS API Documentation  3.3.0-Master (c515a66)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRendererCategory Class Reference

categorized renderer More...

#include <qgscategorizedsymbolrenderer.h>

Public Member Functions

 QgsRendererCategory ()=default
 Constructor for QgsRendererCategory. More...
 
 QgsRendererCategory (const QVariant &value, QgsSymbol *symbol, const QString &label, bool render=true)
 takes ownership of symbol More...
 
 QgsRendererCategory (const QgsRendererCategory &cat)
 copy constructor More...
 
QString dump () const
 
QString label () const
 
QgsRendererCategoryoperator= (QgsRendererCategory cat)
 
bool renderState () const
 Returns true if the category is currently enabled and should be rendered. More...
 
void setLabel (const QString &label)
 
void setRenderState (bool render)
 Sets whether the category is currently enabled and should be rendered. More...
 
void setSymbol (QgsSymbol *s)
 
void setValue (const QVariant &value)
 
QgsSymbolsymbol () const
 
void toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
 
QVariant value () const
 

Protected Member Functions

void swap (QgsRendererCategory &other)
 

Protected Attributes

QString mLabel
 
bool mRender = true
 
std::unique_ptr< QgsSymbolmSymbol
 
QVariant mValue
 

Detailed Description

categorized renderer

Definition at line 34 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 
)

takes ownership of symbol

Definition at line 37 of file qgscategorizedsymbolrenderer.cpp.

◆ QgsRendererCategory() [3/3]

QgsRendererCategory::QgsRendererCategory ( const QgsRendererCategory cat)

copy constructor

Definition at line 45 of file qgscategorizedsymbolrenderer.cpp.

Member Function Documentation

◆ dump()

QString QgsRendererCategory::dump ( ) const

Definition at line 107 of file qgscategorizedsymbolrenderer.cpp.

◆ label()

QString QgsRendererCategory::label ( ) const

Definition at line 77 of file qgscategorizedsymbolrenderer.cpp.

◆ operator=()

QgsRendererCategory & QgsRendererCategory::operator= ( QgsRendererCategory  cat)

Definition at line 54 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 82 of file qgscategorizedsymbolrenderer.cpp.

◆ setLabel()

void QgsRendererCategory::setLabel ( const QString &  label)

Definition at line 97 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 102 of file qgscategorizedsymbolrenderer.cpp.

◆ setSymbol()

void QgsRendererCategory::setSymbol ( QgsSymbol s)

Definition at line 92 of file qgscategorizedsymbolrenderer.cpp.

◆ setValue()

void QgsRendererCategory::setValue ( const QVariant &  value)

Definition at line 87 of file qgscategorizedsymbolrenderer.cpp.

◆ swap()

void QgsRendererCategory::swap ( QgsRendererCategory other)
protected

Definition at line 60 of file qgscategorizedsymbolrenderer.cpp.

◆ symbol()

QgsSymbol * QgsRendererCategory::symbol ( ) const

Definition at line 72 of file qgscategorizedsymbolrenderer.cpp.

◆ toSld()

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

Definition at line 112 of file qgscategorizedsymbolrenderer.cpp.

◆ value()

QVariant QgsRendererCategory::value ( ) const

Definition at line 67 of file qgscategorizedsymbolrenderer.cpp.

Member Data Documentation

◆ mLabel

QString QgsRendererCategory::mLabel
protected

Definition at line 81 of file qgscategorizedsymbolrenderer.h.

◆ mRender

bool QgsRendererCategory::mRender = true
protected

Definition at line 82 of file qgscategorizedsymbolrenderer.h.

◆ mSymbol

std::unique_ptr<QgsSymbol> QgsRendererCategory::mSymbol
protected

Definition at line 80 of file qgscategorizedsymbolrenderer.h.

◆ mValue

QVariant QgsRendererCategory::mValue
protected

Definition at line 79 of file qgscategorizedsymbolrenderer.h.


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