The QgsConditionalLayerStyles class holds conditional style information for a layer. More...

#include <qgsconditionalstyle.h>

Inheritance diagram for QgsConditionalLayerStyles:

Signals
void	changed ()
	Emitted when the conditional styles are changed.

Public Member Functions
	QgsConditionalLayerStyles (QObject *parent=nullptr)
	Constructor for QgsConditionalLayerStyles, with the specified parent object.

QgsConditionalStyle	constraintFailureStyles (QgsFieldConstraints::ConstraintStrength strength)
	Returns a style associated to a constraint failure.

QList< QgsConditionalStyle >	fieldStyles (const QString &fieldName) const
	Returns the conditional styles set for the field with matching fieldName.

bool	readXml (const QDomNode &node, const QgsReadWriteContext &context)
	Reads the condition styles state from a DOM node.

QgsConditionalStyles	rowStyles () const
	Returns a list of row styles associated with the layer.

bool	rulesNeedGeometry () const
	Returns `true` if at least one rule needs geometry.

void	setFieldStyles (const QString &fieldName, const QList< QgsConditionalStyle > &styles)
	Set the conditional styles for a field, with the specified fieldName.

void	setRowStyles (const QgsConditionalStyles &styles)
	Sets the conditional styles that apply to full rows of data in the attribute table.

bool	writeXml (QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context) const
	Writes the condition styles state to a DOM node.

Detailed Description

The QgsConditionalLayerStyles class holds conditional style information for a layer.

This includes field styles and full row styles.

Definition at line 42 of file qgsconditionalstyle.h.

Constructor & Destructor Documentation

◆ QgsConditionalLayerStyles()

QgsConditionalLayerStyles::QgsConditionalLayerStyles ( QObject * parent = nullptr )

Constructor for QgsConditionalLayerStyles, with the specified parent object.

Definition at line 25 of file qgsconditionalstyle.cpp.

Member Function Documentation

◆ changed

void QgsConditionalLayerStyles::changed ( )

signal

Emitted when the conditional styles are changed.

Since: QGIS 3.10

◆ constraintFailureStyles()

QgsConditionalStyle QgsConditionalLayerStyles::constraintFailureStyles ( QgsFieldConstraints::ConstraintStrength strength )

Returns a style associated to a constraint failure.

Parameters

strength the type of constraint

Since: QGIS 3.30

Definition at line 30 of file qgsconditionalstyle.cpp.

◆ fieldStyles()

QList< QgsConditionalStyle > QgsConditionalLayerStyles::fieldStyles ( const QString & fieldName ) const

Returns the conditional styles set for the field with matching fieldName.

See also: setFieldStyles()

Definition at line 80 of file qgsconditionalstyle.cpp.

◆ readXml()

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

Reads the condition styles state from a DOM node.

See also: writeXml()

Definition at line 129 of file qgsconditionalstyle.cpp.

◆ rowStyles()

QgsConditionalStyles QgsConditionalLayerStyles::rowStyles ( ) const

Returns a list of row styles associated with the layer.

See also: setRowStyles()

Definition at line 57 of file qgsconditionalstyle.cpp.

◆ rulesNeedGeometry()

bool QgsConditionalLayerStyles::rulesNeedGeometry ( ) const

Returns true if at least one rule needs geometry.

Since: QGIS 3.26.3

Definition at line 117 of file qgsconditionalstyle.cpp.

◆ setFieldStyles()

void QgsConditionalLayerStyles::setFieldStyles	(	const QString &	fieldName,
		const QList< QgsConditionalStyle > &	styles
	)

Set the conditional styles for a field, with the specified fieldName.

The field value is inserted into a 'value' variable to conduct expression checks.

See also: fieldStyles()

Definition at line 71 of file qgsconditionalstyle.cpp.

◆ setRowStyles()

void QgsConditionalLayerStyles::setRowStyles ( const QgsConditionalStyles & styles )

Sets the conditional styles that apply to full rows of data in the attribute table.

Each row will check be checked against each rule.

See also: rowStyles()

Definition at line 62 of file qgsconditionalstyle.cpp.

◆ writeXml()

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

Writes the condition styles state to a DOM node.

See also: readXml()

Definition at line 85 of file qgsconditionalstyle.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgsconditionalstyle.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgsconditionalstyle.cpp

Signals

Public Member Functions