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.
QVariant	defaultValue () const
	Returns the default value for the parameter.
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.
QString	name () const
	Returns the name of the parameter.
bool	operator== (const QgsExpressionFunction::Parameter &other) const
bool	optional () const
	Returns true if the parameter is optional.

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

name	parameter name, used when named parameter are specified in an expression
optional	set to true if parameter should be optional
defaultValue	default value to use for optional parameters
isSubExpression	set 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:

• /build/qgis-3.34.0+99sid/src/core/expression/qgsexpressionfunction.h