QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRendererRange Class Reference

#include <qgsrendererrange.h>

Public Member Functions

 QgsRendererRange ()=default
 Constructor for QgsRendererRange. More...
 
 QgsRendererRange (const QgsClassificationRange &range, QgsSymbol *symbol, bool render=true)
 Creates a renderer symbol range. More...
 
 QgsRendererRange (const QgsRendererRange &range)
 
 QgsRendererRange (double lowerValue, double upperValue, QgsSymbol *symbol, const QString &label, bool render=true)
 
 ~QgsRendererRange ()
 
QString dump () const
 
QString label () const
 
double lowerValue () const
 
bool operator< (const QgsRendererRange &other) const
 
QgsRendererRangeoperator= (QgsRendererRange range)
 
bool renderState () const
 
void setLabel (const QString &label)
 
void setLowerValue (double lowerValue)
 
void setRenderState (bool render)
 
void setSymbol (QgsSymbol *s)
 
void setUpperValue (double upperValue)
 
QgsSymbolsymbol () const
 
void toSld (QDomDocument &doc, QDomElement &element, QVariantMap props, bool firstRange=false) const
 Creates a DOM element representing the range in SLD format. More...
 
double upperValue () const
 

Protected Member Functions

void swap (QgsRendererRange &other)
 

Protected Attributes

QString mLabel
 
double mLowerValue = 0
 
bool mRender = true
 
std::unique_ptr< QgsSymbolmSymbol
 
double mUpperValue = 0
 

Detailed Description

Definition at line 36 of file qgsrendererrange.h.

Constructor & Destructor Documentation

◆ QgsRendererRange() [1/4]

QgsRendererRange::QgsRendererRange ( )
default

Constructor for QgsRendererRange.

◆ ~QgsRendererRange()

QgsRendererRange::~QgsRendererRange ( )
default

◆ QgsRendererRange() [2/4]

QgsRendererRange::QgsRendererRange ( const QgsClassificationRange range,
QgsSymbol symbol,
bool  render = true 
)

Creates a renderer symbol range.

Parameters
rangeThe classification range
symbolThe symbol for this renderer range
renderIf true, it will be renderered

Definition at line 23 of file qgsrendererrange.cpp.

◆ QgsRendererRange() [3/4]

QgsRendererRange::QgsRendererRange ( double  lowerValue,
double  upperValue,
QgsSymbol symbol,
const QString &  label,
bool  render = true 
)

Definition at line 32 of file qgsrendererrange.cpp.

◆ QgsRendererRange() [4/4]

QgsRendererRange::QgsRendererRange ( const QgsRendererRange range)

Definition at line 40 of file qgsrendererrange.cpp.

Member Function Documentation

◆ dump()

QString QgsRendererRange::dump ( ) const

Definition at line 124 of file qgsrendererrange.cpp.

◆ label()

QString QgsRendererRange::label ( ) const

Definition at line 89 of file qgsrendererrange.cpp.

◆ lowerValue()

double QgsRendererRange::lowerValue ( ) const

Definition at line 74 of file qgsrendererrange.cpp.

◆ operator<()

bool QgsRendererRange::operator< ( const QgsRendererRange other) const

Definition at line 58 of file qgsrendererrange.cpp.

◆ operator=()

QgsRendererRange & QgsRendererRange::operator= ( QgsRendererRange  range)

Definition at line 52 of file qgsrendererrange.cpp.

◆ renderState()

bool QgsRendererRange::renderState ( ) const

Definition at line 114 of file qgsrendererrange.cpp.

◆ setLabel()

void QgsRendererRange::setLabel ( const QString &  label)

Definition at line 99 of file qgsrendererrange.cpp.

◆ setLowerValue()

void QgsRendererRange::setLowerValue ( double  lowerValue)

Definition at line 109 of file qgsrendererrange.cpp.

◆ setRenderState()

void QgsRendererRange::setRenderState ( bool  render)

Definition at line 119 of file qgsrendererrange.cpp.

◆ setSymbol()

void QgsRendererRange::setSymbol ( QgsSymbol s)

Definition at line 94 of file qgsrendererrange.cpp.

◆ setUpperValue()

void QgsRendererRange::setUpperValue ( double  upperValue)

Definition at line 104 of file qgsrendererrange.cpp.

◆ swap()

void QgsRendererRange::swap ( QgsRendererRange other)
protected

Definition at line 66 of file qgsrendererrange.cpp.

◆ symbol()

QgsSymbol * QgsRendererRange::symbol ( ) const

Definition at line 84 of file qgsrendererrange.cpp.

◆ toSld()

void QgsRendererRange::toSld ( QDomDocument &  doc,
QDomElement &  element,
QVariantMap  props,
bool  firstRange = false 
) const

Creates a DOM element representing the range in SLD format.

Parameters
docDOM document
elementdestination DOM element
propsgraduated renderer properties
firstRangeset to true if the range is the first range, where the lower value uses a <= test rather than a < test.

Definition at line 129 of file qgsrendererrange.cpp.

◆ upperValue()

double QgsRendererRange::upperValue ( ) const

Definition at line 79 of file qgsrendererrange.cpp.

Member Data Documentation

◆ mLabel

QString QgsRendererRange::mLabel
protected

Definition at line 92 of file qgsrendererrange.h.

◆ mLowerValue

double QgsRendererRange::mLowerValue = 0
protected

Definition at line 90 of file qgsrendererrange.h.

◆ mRender

bool QgsRendererRange::mRender = true
protected

Definition at line 93 of file qgsrendererrange.h.

◆ mSymbol

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

Definition at line 91 of file qgsrendererrange.h.

◆ mUpperValue

double QgsRendererRange::mUpperValue = 0
protected

Definition at line 90 of file qgsrendererrange.h.


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