QgsConditionalStyle Class Reference

Conditional styling for a rule. More...

#include <qgsconditionalstyle.h>

Public Member Functions
	QgsConditionalStyle ()
	QgsConditionalStyle (const QgsConditionalStyle &other)
	QgsConditionalStyle (const QString &rule)
	~QgsConditionalStyle ()
QColor	backgroundColor () const
	The background color for style.
QString	displayText () const
	The name of the style.
QFont	font () const
	The font for the style.
QPixmap	icon () const
	The icon set for style generated from the set symbol.
bool	isValid () const
	isValid Check if this rule is valid.
bool	matches (const QVariant &value, QgsExpressionContext &context) const
	Check if the rule matches using the given value and feature.
QString	name () const
	The name of the style.
bool	operator!= (const QgsConditionalStyle &other) const
QgsConditionalStyle &	operator= (const QgsConditionalStyle &other)
bool	operator== (const QgsConditionalStyle &other) const
bool	readXml (const QDomNode &node, const QgsReadWriteContext &context)
	Reads vector conditional style specific state from layer Dom node.
QPixmap	renderPreview (const QSize &size=QSize()) const
	Render a preview icon of the rule, at the specified size.
QString	rule () const
	The condition rule set for the style.
void	setBackgroundColor (const QColor &value)
	Set the background color for the style.
void	setFont (const QFont &value)
	Set the font for the style.
void	setName (const QString &value)
	Set the name of the style.
void	setRule (const QString &value)
	Set the rule for the style.
void	setSymbol (QgsSymbol *value)
	Set the icon for the style.
void	setTextColor (const QColor &value)
	Set the text color for the style.
QgsSymbol *	symbol () const
	The symbol used to generate the icon for the style.
QColor	textColor () const
	The text color set for style.
bool	validBackgroundColor () const
	Check if the background color is valid for render.
bool	validTextColor () const
	Check if the text color is valid for render.
bool	writeXml (QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context) const
	Write vector conditional style specific state from layer Dom node.

Static Public Member Functions
static QgsConditionalStyle	compressStyles (const QList< QgsConditionalStyle > &styles)
	Compress a list of styles into a single style.
static QgsConditionalStyle	matchingConditionalStyle (const QList< QgsConditionalStyle > &styles, const QVariant &value, QgsExpressionContext &context)
	Find and return the matching style for the value and feature.
static QList< QgsConditionalStyle >	matchingConditionalStyles (const QList< QgsConditionalStyle > &styles, const QVariant &value, QgsExpressionContext &context)
	Find and return the matching styles for the value and feature.

Detailed Description

Conditional styling for a rule.

Definition at line 131 of file qgsconditionalstyle.h.

Constructor & Destructor Documentation

QgsConditionalStyle() [1/3]

QgsConditionalStyle::QgsConditionalStyle

(

)

Definition at line 168 of file qgsconditionalstyle.cpp.

QgsConditionalStyle() [2/3]

QgsConditionalStyle::QgsConditionalStyle

(

const QgsConditionalStyle &

other

)

Definition at line 178 of file qgsconditionalstyle.cpp.

QgsConditionalStyle() [3/3]

QgsConditionalStyle::QgsConditionalStyle

(

const QString &

rule

)

Definition at line 171 of file qgsconditionalstyle.cpp.

~QgsConditionalStyle()

QgsConditionalStyle::~QgsConditionalStyle ( )

default

Member Function Documentation

backgroundColor()

QColor QgsConditionalStyle::backgroundColor ( ) const

inline

The background color for style.

Returns

QColor for background color

Definition at line 236 of file qgsconditionalstyle.h.

compressStyles()

QgsConditionalStyle QgsConditionalStyle::compressStyles ( const QList< QgsConditionalStyle > &  styles )

static

Compress a list of styles into a single style.

This can be used to stack the elements of the styles. The font of the last style is used in the output.

Parameters

styles

The list of styles to compress down

Returns

A single style generated from joining each style property.

Definition at line 305 of file qgsconditionalstyle.cpp.

displayText()

QString QgsConditionalStyle::displayText

(

)

const

The name of the style.

Returns

The name of the style. Names are optional so might be empty.

Definition at line 211 of file qgsconditionalstyle.cpp.

font()

QFont QgsConditionalStyle::font ( ) const

inline

The font for the style.

Returns

QFont for the style

Definition at line 249 of file qgsconditionalstyle.h.

icon()

QPixmap QgsConditionalStyle::icon ( ) const

inline

The icon set for style generated from the set symbol.

Returns

A QPixmap that was set for the icon using the symbol

Definition at line 211 of file qgsconditionalstyle.h.

isValid()

bool QgsConditionalStyle::isValid ( ) const

inline

isValid Check if this rule is valid.

A valid rule has one or more properties set.

Returns

true if the rule is valid.

Definition at line 263 of file qgsconditionalstyle.h.

matches()

bool QgsConditionalStyle::matches	(	const QVariant &	value,
		QgsExpressionContext &	context
	)		const

Check if the rule matches using the given value and feature.

Parameters

value	The current value being checked. The "value" variable from the context is replaced with this value.
context	Expression context for evaluating rule expression

Returns

true of the rule matches against the given feature

Definition at line 233 of file qgsconditionalstyle.cpp.

matchingConditionalStyle()

QgsConditionalStyle QgsConditionalStyle::matchingConditionalStyle ( const QList< QgsConditionalStyle > &  styles, const QVariant &  value, QgsExpressionContext &  context  )

static

Find and return the matching style for the value and feature.

If no match is found a invalid QgsConditionalStyle is return.

Returns

A conditional style that matches the value and feature. Check with QgsConditionalStyle::isValid()

Definition at line 294 of file qgsconditionalstyle.cpp.

matchingConditionalStyles()

QList< QgsConditionalStyle > QgsConditionalStyle::matchingConditionalStyles ( const QList< QgsConditionalStyle > &  styles, const QVariant &  value, QgsExpressionContext &  context  )

static

Find and return the matching styles for the value and feature.

If no match is found a invalid QgsConditionalStyle is return.

Returns

A conditional style that matches the value and feature. Check with QgsConditionalStyle::isValid()

Definition at line 282 of file qgsconditionalstyle.cpp.

name()

QString QgsConditionalStyle::name ( ) const

inline

The name of the style.

Returns

The name of the style. Names are optional so might be empty.

Definition at line 205 of file qgsconditionalstyle.h.

operator!=()

bool QgsConditionalStyle::operator!=

(

const QgsConditionalStyle &

other

)

const

Definition at line 362 of file qgsconditionalstyle.cpp.

operator=()

QgsConditionalStyle & QgsConditionalStyle::operator=

(

const QgsConditionalStyle &

other

)

Definition at line 191 of file qgsconditionalstyle.cpp.

operator==()

bool QgsConditionalStyle::operator==

(

const QgsConditionalStyle &

other

)

const

Definition at line 350 of file qgsconditionalstyle.cpp.

readXml()

bool QgsConditionalStyle::readXml	(	const QDomNode &	node,
		const QgsReadWriteContext &	context
	)

Reads vector conditional style specific state from layer Dom node.

Definition at line 367 of file qgsconditionalstyle.cpp.

renderPreview()

QPixmap QgsConditionalStyle::renderPreview

(

const QSize &

size = QSize()

)

const

Render a preview icon of the rule, at the specified size.

If size is not specified, a default size will be used.

Returns

QPixmap preview of the style

Definition at line 240 of file qgsconditionalstyle.cpp.

rule()

QString QgsConditionalStyle::rule ( ) const

inline

The condition rule set for the style.

Rule may contain variable @value to represent the current value

Returns

QString of the current set rule

Definition at line 256 of file qgsconditionalstyle.h.

setBackgroundColor()

void QgsConditionalStyle::setBackgroundColor ( const QColor &  value )

inline

Set the background color for the style.

Parameters

value

QColor for background color

Definition at line 175 of file qgsconditionalstyle.h.

setFont()

void QgsConditionalStyle::setFont ( const QFont &  value )

inline

Set the font for the style.

Parameters

value

QFont to be used for text

Definition at line 187 of file qgsconditionalstyle.h.

setName()

void QgsConditionalStyle::setName ( const QString &  value )

inline

Set the name of the style.

Names are optional but handy for display

Parameters

value

The name given to the style

Definition at line 162 of file qgsconditionalstyle.h.

setRule()

void QgsConditionalStyle::setRule ( const QString &  value )

inline

Set the rule for the style.

Rules should be of QgsExpression syntax. Special value of @value is replaced at run time with the check value

Parameters

value

The QgsExpression style rule to use for this style

Definition at line 169 of file qgsconditionalstyle.h.

setSymbol()

void QgsConditionalStyle::setSymbol

(

QgsSymbol *

value

)

Set the icon for the style.

Icons are generated from symbols

Parameters

value

QgsSymbol to be used when generating the icon

Definition at line 219 of file qgsconditionalstyle.cpp.

setTextColor()

void QgsConditionalStyle::setTextColor ( const QColor &  value )

inline

Set the text color for the style.

Parameters

value

QColor for text color

Definition at line 181 of file qgsconditionalstyle.h.

symbol()

QgsSymbol * QgsConditionalStyle::symbol ( ) const

inline

The symbol used to generate the icon for the style.

Returns

The QgsSymbol used for the icon

Definition at line 217 of file qgsconditionalstyle.h.

textColor()

QColor QgsConditionalStyle::textColor ( ) const

inline

The text color set for style.

Returns

QColor for text color

Definition at line 223 of file qgsconditionalstyle.h.

validBackgroundColor()

bool QgsConditionalStyle::validBackgroundColor

(

)

const

Check if the background color is valid for render.

Valid colors are non invalid QColors and a color with a > 0 alpha

Returns

true of the color set for background is valid.

Definition at line 272 of file qgsconditionalstyle.cpp.

validTextColor()

bool QgsConditionalStyle::validTextColor

(

)

const

Check if the text color is valid for render.

Valid colors are non invalid QColors and a color with a > 0 alpha

Returns

true of the color set for text is valid.

Definition at line 277 of file qgsconditionalstyle.cpp.

writeXml()

bool QgsConditionalStyle::writeXml	(	QDomNode &	node,
		QDomDocument &	doc,
		const QgsReadWriteContext &	context
	)		const

Write vector conditional style specific state from layer Dom node.

Definition at line 324 of file qgsconditionalstyle.cpp.

---

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

• /build/qgis-3.36.0+99sid/src/core/qgsconditionalstyle.h
• /build/qgis-3.36.0+99sid/src/core/qgsconditionalstyle.cpp