QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsExpressionFunction::Parameter Class Reference

Represents a single parameter passed to a function. More...

#include <qgsexpressionfunction.h>

Public Member Functions

 Parameter (const QString &name, bool optional=false, const QVariant &defaultValue=QVariant(), bool isSubExpression=false)
 Constructor for Parameter. More...
 
QVariant defaultValue () const
 Returns the default value for the parameter. More...
 
bool isSubExpression () const
 Returns true if parameter argument is a separate sub-expression, and should not be checked while determining referenced columns for the expression. More...
 
QString name () const
 Returns the name of the parameter. More...
 
bool operator== (const QgsExpressionFunction::Parameter &other) const
 
bool optional () const
 Returns true if the parameter is optional. More...
 

Detailed Description

Represents a single parameter passed to a function.

Since
QGIS 2.16

Definition at line 54 of file qgsexpressionfunction.h.

Constructor & Destructor Documentation

◆ Parameter()

QgsExpressionFunction::Parameter::Parameter ( const QString &  name,
bool  optional = false,
const QVariant &  defaultValue = QVariant(),
bool  isSubExpression = false 
)
inline

Constructor for Parameter.

Parameters
nameparameter name, used when named parameter are specified in an expression
optionalset to true if parameter should be optional
defaultValuedefault value to use for optional parameters
isSubExpressionset to true if this parameter is a sub-expression

Definition at line 65 of file qgsexpressionfunction.h.

Member Function Documentation

◆ defaultValue()

QVariant QgsExpressionFunction::Parameter::defaultValue ( ) const
inline

Returns the default value for the parameter.

Definition at line 82 of file qgsexpressionfunction.h.

◆ isSubExpression()

bool QgsExpressionFunction::Parameter::isSubExpression ( ) const
inline

Returns true if parameter argument is a separate sub-expression, and should not be checked while determining referenced columns for the expression.

Since
QGIS 3.2

Definition at line 89 of file qgsexpressionfunction.h.

◆ name()

QString QgsExpressionFunction::Parameter::name ( ) const
inline

Returns the name of the parameter.

Definition at line 76 of file qgsexpressionfunction.h.

◆ operator==()

bool QgsExpressionFunction::Parameter::operator== ( const QgsExpressionFunction::Parameter other) const
inline

Definition at line 91 of file qgsexpressionfunction.h.

◆ optional()

bool QgsExpressionFunction::Parameter::optional ( ) const
inline

Returns true if the parameter is optional.

Definition at line 79 of file qgsexpressionfunction.h.


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