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

Private Attributes

QString mName
 
int mParams
 
bool mUsesGeometry
 
QString mGroup
 
QString mHelpText
 
QStringList mReferencedColumns
 

Detailed Description

A abstract base class for defining QgsExpression functions.

Definition at line 249 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 252 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 264 of file qgsexpression.h.

Referenced by QgsExpressionBuilderWidget::QgsExpressionBuilderWidget().

QString QgsExpression::Function::helptext ( )
inline

The help text for the function.

Definition at line 266 of file qgsexpression.h.

References QgsExpression::helptext().

Referenced by QgsExpressionBuilderWidget::QgsExpressionBuilderWidget().

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

Definition at line 270 of file qgsexpression.h.

References mName.

int QgsExpression::Function::params ( )
inline
virtual QStringList QgsExpression::Function::referencedColumns ( ) const
inlinevirtual

Definition at line 261 of file qgsexpression.h.

Referenced by QgsExpression::NodeFunction::referencedColumns().

bool QgsExpression::Function::usesgeometry ( )
inline

Does this function use a geometry object.

Definition at line 259 of file qgsexpression.h.

Member Data Documentation

QString QgsExpression::Function::mGroup
private

Definition at line 282 of file qgsexpression.h.

QString QgsExpression::Function::mHelpText
private

Definition at line 283 of file qgsexpression.h.

QString QgsExpression::Function::mName
private

Definition at line 279 of file qgsexpression.h.

Referenced by operator==().

int QgsExpression::Function::mParams
private

Definition at line 280 of file qgsexpression.h.

QStringList QgsExpression::Function::mReferencedColumns
private

Definition at line 284 of file qgsexpression.h.

bool QgsExpression::Function::mUsesGeometry
private

Definition at line 281 of file qgsexpression.h.


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