QGIS API Documentation 4.3.0-Master (bd2f5e21fd1)
Loading...
Searching...
No Matches
QgsEsriArcadeFunctionDeclarationStatement Class Reference

Represents a function declaration statement. More...

#include <qgsesriarcadescript.h>

Inheritance diagram for QgsEsriArcadeFunctionDeclarationStatement:

Public Member Functions

 QgsEsriArcadeFunctionDeclarationStatement (const QString &functionName, const QStringList &parameters, QgsEsriArcadeBlockStatement *body)
 Constructor for QgsEsriArcadeFunctionDeclarationStatement.
void accept (QgsEsriArcadeVisitor &visitor) const override
 Accepts a visitor to traverse the node.
QgsEsriArcadeBlockStatement * body () const
 Returns the function body block.
QgsEsriArcadeNode * clone () const override
 Creates a copy of the node.
QString dump () const override
 Returns the formatted script representation of the node.
QString functionName () const
 Returns the function name.
QgsEsriArcadeNode::NodeType nodeType () const override
 Returns the node type.
QStringList parameters () const
 Returns the parameter names.
Public Member Functions inherited from QgsEsriArcadeStatement
 ~QgsEsriArcadeStatement () override=default
Public Member Functions inherited from QgsEsriArcadeNode
virtual ~QgsEsriArcadeNode ()=default

Additional Inherited Members

Public Types inherited from QgsEsriArcadeNode
enum class  NodeType {
  BlockStatement , VariableDeclarationStatement , ReturnStatement , AssignmentStatement ,
  FunctionDeclarationStatement , ExpressionStatement , LiteralExpression , VariableReferenceExpression ,
  ProfileVariableReferenceExpression , MemberAccessExpression , BinaryOperatorExpression , UnaryOperatorExpression ,
  FunctionCallExpression , IndexExpression , ArrayLiteralExpression , DictionaryLiteralExpression ,
  IfStatement , ForStatement , ForInStatement , WhileStatement ,
  BreakStatement , ContinueStatement
}
 Node type identifier. More...

Detailed Description

Represents a function declaration statement.

For example function foo(a, b) { ... }).

Since
QGIS 4.4

Definition at line 444 of file qgsesriarcadescript.h.

Constructor & Destructor Documentation

◆ QgsEsriArcadeFunctionDeclarationStatement()

QgsEsriArcadeFunctionDeclarationStatement::QgsEsriArcadeFunctionDeclarationStatement ( const QString & functionName,
const QStringList & parameters,
QgsEsriArcadeBlockStatement * body )

Constructor for QgsEsriArcadeFunctionDeclarationStatement.

Ownership of body is transferred to this statement.

Definition at line 166 of file qgsesriarcadescript.cpp.

Member Function Documentation

◆ accept()

void QgsEsriArcadeFunctionDeclarationStatement::accept ( QgsEsriArcadeVisitor & visitor) const
overridevirtual

Accepts a visitor to traverse the node.

Implements QgsEsriArcadeNode.

Definition at line 186 of file qgsesriarcadescript.cpp.

◆ body()

QgsEsriArcadeBlockStatement * QgsEsriArcadeFunctionDeclarationStatement::body ( ) const
inline

Returns the function body block.

Definition at line 472 of file qgsesriarcadescript.h.

◆ clone()

QgsEsriArcadeNode * QgsEsriArcadeFunctionDeclarationStatement::clone ( ) const
overridevirtual

Creates a copy of the node.

Caller takes ownership of the returned object.

Implements QgsEsriArcadeNode.

Definition at line 181 of file qgsesriarcadescript.cpp.

◆ dump()

QString QgsEsriArcadeFunctionDeclarationStatement::dump ( ) const
overridevirtual

Returns the formatted script representation of the node.

This can be used to export a script node back to a valid Esri arcade script string.

Implements QgsEsriArcadeNode.

Definition at line 172 of file qgsesriarcadescript.cpp.

◆ functionName()

QString QgsEsriArcadeFunctionDeclarationStatement::functionName ( ) const
inline

Returns the function name.

Definition at line 462 of file qgsesriarcadescript.h.

◆ nodeType()

QgsEsriArcadeNode::NodeType QgsEsriArcadeFunctionDeclarationStatement::nodeType ( ) const
inlineoverridevirtual

Returns the node type.

Implements QgsEsriArcadeNode.

Definition at line 454 of file qgsesriarcadescript.h.

◆ parameters()

QStringList QgsEsriArcadeFunctionDeclarationStatement::parameters ( ) const
inline

Returns the parameter names.

Definition at line 467 of file qgsesriarcadescript.h.


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