QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsConditionalLayerStyles Class Reference

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

#include <qgsconditionalstyle.h>

Public Member Functions

 QgsConditionalLayerStyles ()
 
QList< QgsConditionalStylefieldStyles (const QString &fieldName)
 Returns the conditional styles set for the field UI properties. More...
 
bool readXml (const QDomNode &node)
 Reads field ui properties specific state from Dom node. More...
 
QList< QgsConditionalStylerowStyles ()
 
void setFieldStyles (const QString &fieldName, const QList< QgsConditionalStyle > &styles)
 Set the conditional styles for the field UI properties. More...
 
void setRowStyles (const QList< QgsConditionalStyle > &styles)
 Set the conditional styles that apply to full rows of data in the attribute table. More...
 
bool writeXml (QDomNode &node, QDomDocument &doc) const
 Write field ui properties specific state from Dom node. More...
 

Detailed Description

The QgsConditionalLayerStyles class holds conditional style information for a layer.

This includes field styles and full row styles.

Definition at line 22 of file qgsconditionalstyle.h.

Constructor & Destructor Documentation

◆ QgsConditionalLayerStyles()

QgsConditionalLayerStyles::QgsConditionalLayerStyles ( )

Definition at line 23 of file qgsconditionalstyle.cpp.

Member Function Documentation

◆ fieldStyles()

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

Returns the conditional styles set for the field UI properties.

Returns
A list of conditional styles that have been set.

Definition at line 42 of file qgsconditionalstyle.cpp.

◆ readXml()

bool QgsConditionalLayerStyles::readXml ( const QDomNode node)

Reads field ui properties specific state from Dom node.

Definition at line 82 of file qgsconditionalstyle.cpp.

◆ rowStyles()

QList< QgsConditionalStyle > QgsConditionalLayerStyles::rowStyles ( )

Definition at line 27 of file qgsconditionalstyle.cpp.

◆ setFieldStyles()

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

Set the conditional styles for the field UI properties.

Parameters
fieldNamename of field
styles

Definition at line 37 of file qgsconditionalstyle.cpp.

◆ setRowStyles()

void QgsConditionalLayerStyles::setRowStyles ( const QList< QgsConditionalStyle > &  styles)

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

Each row will check be checked against each rule.

Parameters
stylesThe styles to assign to all the rows
Note
added in QGIS 2.12

Definition at line 32 of file qgsconditionalstyle.cpp.

◆ writeXml()

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

Write field ui properties specific state from Dom node.

Definition at line 51 of file qgsconditionalstyle.cpp.


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