QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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

 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)
 
virtual ~StaticFunction ()
 
virtual QStringList aliases () const override
 Returns a list of possible aliases for the function. More...
 
virtual QVariant func (const QVariantList &values, const QgsFeature *f, QgsExpression *parent) override
 
- 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)
 
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 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 358 of file qgsexpression.h.

Constructor & Destructor Documentation

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 361 of file qgsexpression.h.

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

Definition at line 376 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 383 of file qgsexpression.h.

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

Implements QgsExpression::Function.

Definition at line 378 of file qgsexpression.h.


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