QGIS API Documentation  2.5.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())
 
QString name ()
 The name of the function. More...
 
int params ()
 The number of parameters this function takes. More...
 
bool usesgeometry ()
 Does this function use a geometry object. More...
 
virtual QStringList referencedColumns () const
 
QString group ()
 The group the function belongs to. More...
 
QString helptext ()
 The help text for the function. More...
 
virtual QVariant func (const QVariantList &values, const QgsFeature *f, QgsExpression *parent)=0
 
bool operator== (const Function &other) const
 

Detailed Description

A abstract base class for defining QgsExpression functions.

Constructor & Destructor Documentation

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

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.

QString QgsExpression::Function::helptext ( )
inline

The help text for the function.

QString QgsExpression::Function::name ( )
inline

The name of the function.

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

The number of parameters this function takes.

virtual QStringList QgsExpression::Function::referencedColumns ( ) const
inlinevirtual
bool QgsExpression::Function::usesgeometry ( )
inline

Does this function use a geometry object.


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