QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Static Public Member Functions | List of all members
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. More...
 
QString displayText () const
 The name of the style. More...
 
QFont font () const
 The font for the style. More...
 
QPixmap icon () const
 The icon set for style generated from the set symbol. More...
 
bool isValid () const
 isValid Check if this rule is valid. More...
 
bool matches (const QVariant &value, QgsExpressionContext &context) const
 Check if the rule matches using the given value and feature. More...
 
QString name () const
 The name of the style. More...
 
QgsConditionalStyleoperator= (const QgsConditionalStyle &other)
 
bool readXml (const QDomNode &node)
 Reads vector conditional style specific state from layer Dom node. More...
 
QPixmap renderPreview () const
 Render a preview icon of the rule. More...
 
QString rule () const
 The condition rule set for the style. More...
 
void setBackgroundColor (const QColor &value)
 Set the background color for the style. More...
 
void setFont (const QFont &value)
 Set the font for the the style. More...
 
void setName (const QString &value)
 Set the name of the style. More...
 
void setRule (const QString &value)
 Set the rule for the style. More...
 
void setSymbol (QgsSymbolV2 *value)
 Set the icon for the style. More...
 
void setTextColor (const QColor &value)
 Set the text color for the style. More...
 
QgsSymbolV2symbol () const
 The symbol used to generate the icon for the style. More...
 
QColor textColor () const
 The text color set for style. More...
 
bool validBackgroundColor () const
 Check if the background color is valid for render. More...
 
bool validTextColor () const
 Check if the text color is valid for render. More...
 
bool writeXml (QDomNode &node, QDomDocument &doc) const
 Write vector conditional style specific state from layer Dom node. More...
 

Static Public Member Functions

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

Detailed Description

Conditional styling for a rule.

Definition at line 67 of file qgsconditionalstyle.h.

Constructor & Destructor Documentation

QgsConditionalStyle::QgsConditionalStyle ( )

Definition at line 120 of file qgsconditionalstyle.cpp.

QgsConditionalStyle::QgsConditionalStyle ( const QgsConditionalStyle other)

Definition at line 136 of file qgsconditionalstyle.cpp.

QgsConditionalStyle::QgsConditionalStyle ( const QString rule)

Definition at line 127 of file qgsconditionalstyle.cpp.

QgsConditionalStyle::~QgsConditionalStyle ( )

Definition at line 169 of file qgsconditionalstyle.cpp.

Member Function Documentation

QColor QgsConditionalStyle::backgroundColor ( ) const
inline

The background color for style.

Returns
QColor for background color

Definition at line 169 of file qgsconditionalstyle.h.

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
stylesThe list of styles to compress down
Returns
A single style generated from joining each style property.

Definition at line 262 of file qgsconditionalstyle.cpp.

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 173 of file qgsconditionalstyle.cpp.

QFont QgsConditionalStyle::font ( ) const
inline

The font for the style.

Returns
QFont for the style

Definition at line 181 of file qgsconditionalstyle.h.

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 144 of file qgsconditionalstyle.h.

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 195 of file qgsconditionalstyle.h.

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

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

Parameters
valueThe current value being checked. The "value" variable from the context is replaced with this value.
contextExpression context for evaluating rule expression
Returns
True of the rule matches against the given feature

Definition at line 195 of file qgsconditionalstyle.cpp.

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 condtional style that matches the value and feature. Check with QgsConditionalStyle::isValid()

Definition at line 252 of file qgsconditionalstyle.cpp.

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 condtional style that matches the value and feature. Check with QgsConditionalStyle::isValid()

Definition at line 241 of file qgsconditionalstyle.cpp.

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 138 of file qgsconditionalstyle.h.

QgsConditionalStyle & QgsConditionalStyle::operator= ( const QgsConditionalStyle other)

Definition at line 149 of file qgsconditionalstyle.cpp.

bool QgsConditionalStyle::readXml ( const QDomNode node)

Reads vector conditional style specific state from layer Dom node.

Definition at line 296 of file qgsconditionalstyle.cpp.

QPixmap QgsConditionalStyle::renderPreview ( ) const

Render a preview icon of the rule.

Returns
QPixmap preview of the style

Definition at line 202 of file qgsconditionalstyle.cpp.

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 188 of file qgsconditionalstyle.h.

void QgsConditionalStyle::setBackgroundColor ( const QColor value)
inline

Set the background color for the style.

Parameters
valueQColor for background color

Definition at line 108 of file qgsconditionalstyle.h.

void QgsConditionalStyle::setFont ( const QFont value)
inline

Set the font for the the style.

Parameters
valueQFont to be used for text

Definition at line 120 of file qgsconditionalstyle.h.

void QgsConditionalStyle::setName ( const QString value)
inline

Set the name of the style.

Names are optional but handy for display

Parameters
valueThe name given to the style

Definition at line 95 of file qgsconditionalstyle.h.

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
valueThe QgsExpression style rule to use for this style

Definition at line 102 of file qgsconditionalstyle.h.

void QgsConditionalStyle::setSymbol ( QgsSymbolV2 value)

Set the icon for the style.

Icons are generated from symbols

Parameters
valueQgsSymbolV2 to be used when generating the icon

Definition at line 181 of file qgsconditionalstyle.cpp.

void QgsConditionalStyle::setTextColor ( const QColor value)
inline

Set the text color for the style.

Parameters
valueQColor for text color

Definition at line 114 of file qgsconditionalstyle.h.

QgsSymbolV2* QgsConditionalStyle::symbol ( ) const
inline

The symbol used to generate the icon for the style.

Returns
The QgsSymbolV2 used for the icon

Definition at line 150 of file qgsconditionalstyle.h.

QColor QgsConditionalStyle::textColor ( ) const
inline

The text color set for style.

Returns
QColor for text color

Definition at line 156 of file qgsconditionalstyle.h.

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 231 of file qgsconditionalstyle.cpp.

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 236 of file qgsconditionalstyle.cpp.

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

Write vector conditional style specific state from layer Dom node.

Definition at line 278 of file qgsconditionalstyle.cpp.


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