QGIS API Documentation
3.0.2-Girona (307d082)
|
Conditional styling for a rule. More...
#include <qgsconditionalstyle.h>
Public Member Functions | |
QgsConditionalStyle () | |
QgsConditionalStyle (const QgsConditionalStyle &other) | |
QgsConditionalStyle (const QString &rule) | |
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... | |
QgsConditionalStyle & | operator= (const QgsConditionalStyle &other) |
bool | readXml (const QDomNode &node, const QgsReadWriteContext &context) |
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 (QgsSymbol *value) |
Set the icon for the style. More... | |
void | setTextColor (const QColor &value) |
Set the text color for the style. More... | |
QgsSymbol * | symbol () 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 QgsReadWriteContext &context) 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< QgsConditionalStyle > | matchingConditionalStyles (const QList< QgsConditionalStyle > &styles, const QVariant &value, QgsExpressionContext &context) |
Find and return the matching styles for the value and feature. More... | |
Conditional styling for a rule.
Definition at line 86 of file qgsconditionalstyle.h.
QgsConditionalStyle::QgsConditionalStyle | ( | ) |
Definition at line 120 of file qgsconditionalstyle.cpp.
QgsConditionalStyle::QgsConditionalStyle | ( | const QgsConditionalStyle & | other | ) |
Definition at line 132 of file qgsconditionalstyle.cpp.
QgsConditionalStyle::QgsConditionalStyle | ( | const QString & | rule | ) |
Definition at line 125 of file qgsconditionalstyle.cpp.
|
inline |
The background color for style.
Definition at line 187 of file qgsconditionalstyle.h.
|
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.
styles | The list of styles to compress down |
Definition at line 254 of file qgsconditionalstyle.cpp.
QString QgsConditionalStyle::displayText | ( | ) | const |
The name of the style.
Definition at line 165 of file qgsconditionalstyle.cpp.
|
inline |
The font for the style.
Definition at line 200 of file qgsconditionalstyle.h.
|
inline |
The icon set for style generated from the set symbol.
Definition at line 162 of file qgsconditionalstyle.h.
|
inline |
isValid Check if this rule is valid.
A valid rule has one or more properties set.
Definition at line 214 of file qgsconditionalstyle.h.
bool QgsConditionalStyle::matches | ( | const QVariant & | value, |
QgsExpressionContext & | context | ||
) | const |
Check if the rule matches using the given value and feature.
value | The current value being checked. The "value" variable from the context is replaced with this value. |
context | Expression context for evaluating rule expression |
Definition at line 187 of file qgsconditionalstyle.cpp.
|
static |
Find and return the matching style for the value and feature.
If no match is found a invalid QgsConditionalStyle is return.
Definition at line 244 of file qgsconditionalstyle.cpp.
|
static |
Find and return the matching styles for the value and feature.
If no match is found a invalid QgsConditionalStyle is return.
Definition at line 233 of file qgsconditionalstyle.cpp.
|
inline |
The name of the style.
Definition at line 156 of file qgsconditionalstyle.h.
QgsConditionalStyle & QgsConditionalStyle::operator= | ( | const QgsConditionalStyle & | other | ) |
Definition at line 145 of file qgsconditionalstyle.cpp.
bool QgsConditionalStyle::readXml | ( | const QDomNode & | node, |
const QgsReadWriteContext & | context | ||
) |
Reads vector conditional style specific state from layer Dom node.
Definition at line 290 of file qgsconditionalstyle.cpp.
QPixmap QgsConditionalStyle::renderPreview | ( | ) | const |
Render a preview icon of the rule.
Definition at line 194 of file qgsconditionalstyle.cpp.
|
inline |
The condition rule set for the style.
Rule may contain variable @value to represent the current value
Definition at line 207 of file qgsconditionalstyle.h.
|
inline |
Set the background color for the style.
value | QColor for background color |
Definition at line 126 of file qgsconditionalstyle.h.
|
inline |
Set the font for the the style.
value | QFont to be used for text |
Definition at line 138 of file qgsconditionalstyle.h.
|
inline |
Set the name of the style.
Names are optional but handy for display
value | The name given to the style |
Definition at line 113 of file qgsconditionalstyle.h.
|
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
value | The QgsExpression style rule to use for this style |
Definition at line 120 of file qgsconditionalstyle.h.
void QgsConditionalStyle::setSymbol | ( | QgsSymbol * | value | ) |
Set the icon for the style.
Icons are generated from symbols
value | QgsSymbol to be used when generating the icon |
Definition at line 173 of file qgsconditionalstyle.cpp.
|
inline |
Set the text color for the style.
value | QColor for text color |
Definition at line 132 of file qgsconditionalstyle.h.
|
inline |
The symbol used to generate the icon for the style.
Definition at line 168 of file qgsconditionalstyle.h.
|
inline |
The text color set for style.
Definition at line 174 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
Definition at line 223 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
Definition at line 228 of file qgsconditionalstyle.cpp.
bool QgsConditionalStyle::writeXml | ( | QDomNode & | node, |
QDomDocument & | doc, | ||
const QgsReadWriteContext & | context | ||
) | const |
Write vector conditional style specific state from layer Dom node.
Definition at line 270 of file qgsconditionalstyle.cpp.