QGIS API Documentation
2.14.0-Essen
|
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be evaluated. More...
#include <qgsexpressioncontext.h>
Public Member Functions | |
QgsExpressionContext () | |
QgsExpressionContext (const QgsExpressionContext &other) | |
Copy constructor. More... | |
~QgsExpressionContext () | |
QgsExpressionContextScope * | activeScopeForVariable (const QString &name) |
Returns the currently active scope from the context for a specified variable name. More... | |
const QgsExpressionContextScope * | activeScopeForVariable (const QString &name) const |
Returns the currently active scope from the context for a specified variable name. More... | |
void | appendScope (QgsExpressionContextScope *scope) |
Appends a scope to the end of the context. More... | |
QgsFeature | feature () const |
Convenience function for retrieving the feature for the context, if set. More... | |
QgsFields | fields () const |
Convenience function for retrieving the fields for the context, if set. More... | |
QStringList | filteredVariableNames () const |
Returns a filtered list of variables names set by all scopes in the context. More... | |
QgsExpression::Function * | function (const QString &name) const |
Fetches a matching function from the context. More... | |
QStringList | functionNames () const |
Retrieves a list of function names contained in the context. More... | |
bool | hasFunction (const QString &name) const |
Checks whether a specified function is contained in the context. More... | |
bool | hasVariable (const QString &name) const |
Check whether a variable is specified by any scope within the context. More... | |
int | indexOfScope (QgsExpressionContextScope *scope) const |
Returns the index of the specified scope if it exists within the context. More... | |
bool | isHighlightedVariable (const QString &name) const |
Returns true if the specified variable name is intended to be highlighted to the user. More... | |
bool | isReadOnly (const QString &name) const |
Returns whether a variable is read only, and should not be modifiable by users. More... | |
QgsExpressionContextScope * | lastScope () |
Returns the last scope added to the context. More... | |
QgsExpressionContext & | operator<< (QgsExpressionContextScope *scope) |
Appends a scope to the end of the context. More... | |
QgsExpressionContext & | operator= (const QgsExpressionContext &other) |
QgsExpressionContextScope * | popScope () |
Removes the last scope from the expression context and return it. More... | |
QgsExpressionContextScope * | scope (int index) |
Returns the scope at the specified index within the context. More... | |
int | scopeCount () const |
Returns the number of scopes contained in the context. More... | |
QList< QgsExpressionContextScope * > | scopes () |
Returns a list of scopes contained within the stack. More... | |
void | setFeature (const QgsFeature &feature) |
Convenience function for setting a feature for the context. More... | |
void | setFields (const QgsFields &fields) |
Convenience function for setting a fields for the context. More... | |
void | setHighlightedVariables (const QStringList &variableNames) |
Sets the list of variable names within the context intended to be highlighted to the user. More... | |
void | setOriginalValueVariable (const QVariant &value) |
Sets the original value variable value for the context. More... | |
QVariant | variable (const QString &name) const |
Fetches a matching variable from the context. More... | |
QStringList | variableNames () const |
Returns a list of variables names set by all scopes in the context. More... | |
Static Public Attributes | |
static const QString | EXPR_FEATURE |
Inbuilt variable name for feature storage. More... | |
static const QString | EXPR_FIELDS |
Inbuilt variable name for fields storage. More... | |
static const QString | EXPR_GEOMETRY_PART_COUNT |
Inbuilt variable name for geometry part count variable. More... | |
static const QString | EXPR_GEOMETRY_PART_NUM |
Inbuilt variable name for geometry part number variable. More... | |
static const QString | EXPR_ORIGINAL_VALUE |
Inbuilt variable name for value original value variable. More... | |
static const QString | EXPR_SYMBOL_ANGLE |
Inbuilt variable name for symbol angle variable. More... | |
static const QString | EXPR_SYMBOL_COLOR |
Inbuilt variable name for symbol color variable. More... | |
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be evaluated.
QgsExpressions can then utilise the information stored within a context to contextualise their evaluated result. A QgsExpressionContext consists of a stack of QgsExpressionContextScope objects, where scopes added later to the stack will override conflicting variables and functions from scopes lower in the stack.
Definition at line 240 of file qgsexpressioncontext.h.
|
inline |
Definition at line 244 of file qgsexpressioncontext.h.
QgsExpressionContext::QgsExpressionContext | ( | const QgsExpressionContext & | other | ) |
Copy constructor.
Definition at line 207 of file qgsexpressioncontext.cpp.
QgsExpressionContext::~QgsExpressionContext | ( | ) |
Definition at line 228 of file qgsexpressioncontext.cpp.
QgsExpressionContextScope * QgsExpressionContext::activeScopeForVariable | ( | const QString & | name | ) |
Returns the currently active scope from the context for a specified variable name.
As scopes later in the stack override earlier contexts, this will be the last matching scope which contains a matching variable.
name | variable name |
Definition at line 273 of file qgsexpressioncontext.cpp.
const QgsExpressionContextScope * QgsExpressionContext::activeScopeForVariable | ( | const QString & | name | ) | const |
Returns the currently active scope from the context for a specified variable name.
As scopes later in the stack override earlier contexts, this will be the last matching scope which contains a matching variable.
name | variable name |
Definition at line 260 of file qgsexpressioncontext.cpp.
void QgsExpressionContext::appendScope | ( | QgsExpressionContextScope * | scope | ) |
Appends a scope to the end of the context.
This scope will override any matching variables or functions provided by existing scopes within the context. Ownership of the scope is transferred to the stack.
scope | expression context to append to context |
Definition at line 386 of file qgsexpressioncontext.cpp.
QgsFeature QgsExpressionContext::feature | ( | ) | const |
Convenience function for retrieving the feature for the context, if set.
Definition at line 413 of file qgsexpressioncontext.cpp.
QgsFields QgsExpressionContext::fields | ( | ) | const |
Convenience function for retrieving the fields for the context, if set.
Definition at line 426 of file qgsexpressioncontext.cpp.
QStringList QgsExpressionContext::filteredVariableNames | ( | ) | const |
Returns a filtered list of variables names set by all scopes in the context.
The included variables are those which should be seen by users.
Definition at line 320 of file qgsexpressioncontext.cpp.
QgsExpression::Function * QgsExpressionContext::function | ( | const QString & | name | ) | const |
Fetches a matching function from the context.
The function will be fetched from the last scope contained within the context which has a matching function set.
name | function name |
Definition at line 368 of file qgsexpressioncontext.cpp.
QStringList QgsExpressionContext::functionNames | ( | ) | const |
Retrieves a list of function names contained in the context.
Definition at line 356 of file qgsexpressioncontext.cpp.
bool QgsExpressionContext::hasFunction | ( | const QString & | name | ) | const |
Checks whether a specified function is contained in the context.
name | function name |
Definition at line 346 of file qgsexpressioncontext.cpp.
bool QgsExpressionContext::hasVariable | ( | const QString & | name | ) | const |
Check whether a variable is specified by any scope within the context.
name | variable name |
Definition at line 234 of file qgsexpressioncontext.cpp.
int QgsExpressionContext::indexOfScope | ( | QgsExpressionContextScope * | scope | ) | const |
Returns the index of the specified scope if it exists within the context.
scope | scope to find |
Definition at line 302 of file qgsexpressioncontext.cpp.
bool QgsExpressionContext::isHighlightedVariable | ( | const QString & | name | ) | const |
Returns true if the specified variable name is intended to be highlighted to the user.
This is used by the expression builder to more prominently display the variable.
name | variable name |
Definition at line 250 of file qgsexpressioncontext.cpp.
bool QgsExpressionContext::isReadOnly | ( | const QString & | name | ) | const |
Returns whether a variable is read only, and should not be modifiable by users.
name | variable name |
Definition at line 336 of file qgsexpressioncontext.cpp.
QgsExpressionContextScope * QgsExpressionContext::lastScope | ( | ) |
Returns the last scope added to the context.
Definition at line 294 of file qgsexpressioncontext.cpp.
QgsExpressionContext & QgsExpressionContext::operator<< | ( | QgsExpressionContextScope * | scope | ) |
Appends a scope to the end of the context.
This scope will override any matching variables or functions provided by existing scopes within the context. Ownership of the scope is transferred to the stack.
Definition at line 399 of file qgsexpressioncontext.cpp.
QgsExpressionContext & QgsExpressionContext::operator= | ( | const QgsExpressionContext & | other | ) |
Definition at line 216 of file qgsexpressioncontext.cpp.
QgsExpressionContextScope * QgsExpressionContext::popScope | ( | ) |
Removes the last scope from the expression context and return it.
Definition at line 391 of file qgsexpressioncontext.cpp.
QgsExpressionContextScope * QgsExpressionContext::scope | ( | int | index | ) |
Returns the scope at the specified index within the context.
index | index of scope |
Definition at line 286 of file qgsexpressioncontext.cpp.
int QgsExpressionContext::scopeCount | ( | ) | const |
Returns the number of scopes contained in the context.
Definition at line 381 of file qgsexpressioncontext.cpp.
|
inline |
Returns a list of scopes contained within the stack.
Definition at line 319 of file qgsexpressioncontext.h.
void QgsExpressionContext::setFeature | ( | const QgsFeature & | feature | ) |
Convenience function for setting a feature for the context.
The feature will be set within the last scope of the context, so will override any existing features within the context.
feature | feature for context |
Definition at line 405 of file qgsexpressioncontext.cpp.
void QgsExpressionContext::setFields | ( | const QgsFields & | fields | ) |
Convenience function for setting a fields for the context.
The fields will be set within the last scope of the context, so will override any existing fields within the context.
fields | fields for context |
Definition at line 418 of file qgsexpressioncontext.cpp.
void QgsExpressionContext::setHighlightedVariables | ( | const QStringList & | variableNames | ) |
Sets the list of variable names within the context intended to be highlighted to the user.
This is used by the expression builder to more prominently display these variables.
variableNames | variable names to highlight |
Definition at line 255 of file qgsexpressioncontext.cpp.
void QgsExpressionContext::setOriginalValueVariable | ( | const QVariant & | value | ) |
Sets the original value variable value for the context.
value | value for original value variable. This usually represents the an original widget value before any data defined overrides have been applied. |
Definition at line 431 of file qgsexpressioncontext.cpp.
Fetches a matching variable from the context.
The variable will be fetched from the last scope contained within the context which has a matching variable set.
name | variable name |
Definition at line 244 of file qgsexpressioncontext.cpp.
QStringList QgsExpressionContext::variableNames | ( | ) | const |
Returns a list of variables names set by all scopes in the context.
Definition at line 310 of file qgsexpressioncontext.cpp.
|
static |
Inbuilt variable name for feature storage.
Definition at line 430 of file qgsexpressioncontext.h.
|
static |
Inbuilt variable name for fields storage.
Definition at line 428 of file qgsexpressioncontext.h.
|
static |
Inbuilt variable name for geometry part count variable.
Definition at line 438 of file qgsexpressioncontext.h.
|
static |
Inbuilt variable name for geometry part number variable.
Definition at line 440 of file qgsexpressioncontext.h.
|
static |
Inbuilt variable name for value original value variable.
Definition at line 432 of file qgsexpressioncontext.h.
|
static |
Inbuilt variable name for symbol angle variable.
Definition at line 436 of file qgsexpressioncontext.h.
|
static |
Inbuilt variable name for symbol color variable.
Definition at line 434 of file qgsexpressioncontext.h.