QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
QgsExpression::Function Class Referenceabstract

A abstract base class for defining QgsExpression functions. More...

#include <qgsexpression.h>

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

Public Member Functions

 Function (QString fnname, int params, QString group, QString helpText=QString(), bool usesGeometry=false, QStringList referencedColumns=QStringList())
 
virtual QVariant func (const QVariantList &values, const QgsFeature *f, QgsExpression *parent)=0
 
QString group ()
 The group the function belongs to. More...
 
QString helptext ()
 The help text for the function. 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

A abstract base class for defining QgsExpression functions.

Definition at line 255 of file qgsexpression.h.

Constructor & Destructor Documentation

QgsExpression::Function::Function ( QString  fnname,
int  params,
QString  group,
QString  helpText = QString(),
bool  usesGeometry = false,
QStringList  referencedColumns = QStringList() 
)
inline

Definition at line 258 of file qgsexpression.h.

Member Function Documentation

virtual QVariant QgsExpression::Function::func ( const QVariantList &  values,
const QgsFeature f,
QgsExpression parent 
)
pure virtual
QString QgsExpression::Function::group ( )
inline

The group the function belongs to.

Definition at line 270 of file qgsexpression.h.

QString QgsExpression::Function::helptext ( )
inline

The help text for the function.

Definition at line 272 of file qgsexpression.h.

QString QgsExpression::Function::name ( )
inline

The name of the function.

Definition at line 261 of file qgsexpression.h.

bool QgsExpression::Function::operator== ( const Function other) const
inline

Definition at line 276 of file qgsexpression.h.

int QgsExpression::Function::params ( )
inline

The number of parameters this function takes.

Definition at line 263 of file qgsexpression.h.

virtual QStringList QgsExpression::Function::referencedColumns ( ) const
inlinevirtual

Definition at line 267 of file qgsexpression.h.

bool QgsExpression::Function::usesgeometry ( )
inline

Does this function use a geometry object.

Definition at line 265 of file qgsexpression.h.


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