QGIS API Documentation  2.11.0-Master
Public Member Functions | List of all members
QgsExpression::StaticFunction Class Reference

#include <qgsexpression.h>

Inheritance diagram for QgsExpression::StaticFunction:
Inheritance graph
[legend]

Public Member Functions

Q_DECL_DEPRECATED StaticFunction (QString fnname, int params, FcnEval fcn, QString group, QString helpText=QString(), bool usesGeometry=false, QStringList referencedColumns=QStringList(), bool lazyEval=false, const QStringList &aliases=QStringList(), bool handlesNull=false)
 
 StaticFunction (QString fnname, int params, FcnEvalContext fcn, QString group, QString helpText=QString(), bool usesGeometry=false, QStringList referencedColumns=QStringList(), bool lazyEval=false, const QStringList &aliases=QStringList(), bool handlesNull=false)
 Static function for evaluation against a QgsExpressionContext. More...
 
virtual ~StaticFunction ()
 
virtual QStringList aliases () const override
 Returns a list of possible aliases for the function. More...
 
virtual Q_DECL_DEPRECATED QVariant func (const QVariantList &values, const QgsFeature *f, QgsExpression *parent) override
 
virtual QVariant func (const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent) override
 Returns result of evaluating the function. More...
 
- Public Member Functions inherited from QgsExpression::Function
 Function (const QString &fnname, int params, QString group, QString helpText=QString(), bool usesGeometry=false, QStringList referencedColumns=QStringList(), bool lazyEval=false, bool handlesNull=false, bool isContextual=false)
 
virtual ~Function ()
 
QString group ()
 The group the function belongs to. More...
 
virtual bool handlesNull () const
 
const QString helptext ()
 The help text for the function. More...
 
bool isContextual () const
 Returns whether the function is only available if provided by a QgsExpressionContext object. More...
 
bool lazyEval ()
 True if this function should use lazy evaluation. More...
 
QString name ()
 The name of the function. More...
 
bool operator== (const Function &other) const
 
int params ()
 The number of parameters this function takes. More...
 
virtual QStringList referencedColumns () const
 
bool usesgeometry ()
 Does this function use a geometry object. More...
 

Detailed Description

Definition at line 425 of file qgsexpression.h.

Constructor & Destructor Documentation

Q_DECL_DEPRECATED QgsExpression::StaticFunction::StaticFunction ( QString  fnname,
int  params,
FcnEval  fcn,
QString  group,
QString  helpText = QString(),
bool  usesGeometry = false,
QStringList  referencedColumns = QStringList(),
bool  lazyEval = false,
const QStringList aliases = QStringList(),
bool  handlesNull = false 
)
inline

Definition at line 428 of file qgsexpression.h.

virtual QgsExpression::StaticFunction::~StaticFunction ( )
inlinevirtual

Definition at line 444 of file qgsexpression.h.

QgsExpression::StaticFunction::StaticFunction ( QString  fnname,
int  params,
FcnEvalContext  fcn,
QString  group,
QString  helpText = QString(),
bool  usesGeometry = false,
QStringList  referencedColumns = QStringList(),
bool  lazyEval = false,
const QStringList aliases = QStringList(),
bool  handlesNull = false 
)
inline

Static function for evaluation against a QgsExpressionContext.

Definition at line 448 of file qgsexpression.h.

Member Function Documentation

virtual QStringList QgsExpression::StaticFunction::aliases ( ) const
inlineoverridevirtual

Returns a list of possible aliases for the function.

These include other permissible names for the function, eg deprecated names.

Returns
list of known aliases
Note
added in QGIS 2.9

Reimplemented from QgsExpression::Function.

Definition at line 476 of file qgsexpression.h.

QVariant QgsExpression::StaticFunction::func ( const QVariantList &  values,
const QgsFeature f,
QgsExpression parent 
)
overridevirtual

Reimplemented from QgsExpression::Function.

Definition at line 3283 of file qgsexpression.cpp.

virtual QVariant QgsExpression::StaticFunction::func ( const QVariantList &  values,
const QgsExpressionContext context,
QgsExpression parent 
)
inlineoverridevirtual

Returns result of evaluating the function.

Parameters
valueslist of values passed to the function
contextcontext expression is being evaluated against
parentparent expression
Returns
result of function

Reimplemented from QgsExpression::Function.

Definition at line 471 of file qgsexpression.h.


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