QGIS API Documentation 4.3.0-Master (0cef2469b72)
Loading...
Searching...
No Matches
QgsVbScriptForEachStatement Class Reference

Represents a for ... each loop. More...

#include <qgsvbscript.h>

Inheritance diagram for QgsVbScriptForEachStatement:

Public Member Functions

 QgsVbScriptForEachStatement (const QString &variableName, QgsVbScriptExpression *collection, QgsVbScriptBlockStatement *body)
 Constructor for QgsVbScriptForEachStatement.
void accept (QgsVbScriptVisitor &visitor) const override
 Accepts a visitor to traverse the node.
QgsVbScriptBlockStatement * body () const
 Returns the loop body block statement.
QgsVbScriptNode * clone () const override
 Creates a copy of the node.
QgsVbScriptExpression * collection () const
 Returns the collection expression being iterated over.
QString dump () const override
 Returns the formatted script representation of the node.
QgsVbScriptNode::NodeType nodeType () const override
 Returns the node type.
QString variableName () const
 Returns the loop variable identifier name.
Public Member Functions inherited from QgsVbScriptStatement
 ~QgsVbScriptStatement () override=default
Public Member Functions inherited from QgsVbScriptNode
virtual ~QgsVbScriptNode ()=default

Additional Inherited Members

Public Types inherited from QgsVbScriptNode
enum class  NodeType {
  BlockStatement , VariableDeclarationStatement , AssignmentStatement , FunctionDeclarationStatement ,
  ExpressionStatement , LiteralExpression , VariableReferenceExpression , MemberAccessExpression ,
  BinaryOperatorExpression , UnaryOperatorExpression , FunctionCallExpression , IndexExpression ,
  ArrayLiteralExpression , IfStatement , ForStatement , ForEachStatement ,
  WhileStatement , ExitStatement , FieldReferenceExpression
}
 Node type identifier. More...

Detailed Description

Represents a for ... each loop.

Since
QGIS 4.4

Definition at line 975 of file qgsvbscript.h.

Constructor & Destructor Documentation

◆ QgsVbScriptForEachStatement()

QgsVbScriptForEachStatement::QgsVbScriptForEachStatement ( const QString & variableName,
QgsVbScriptExpression * collection,
QgsVbScriptBlockStatement * body )

Constructor for QgsVbScriptForEachStatement.

Ownership of collection and body is transferred to this statement.

Definition at line 603 of file qgsvbscript.cpp.

Member Function Documentation

◆ accept()

void QgsVbScriptForEachStatement::accept ( QgsVbScriptVisitor & visitor) const
overridevirtual

Accepts a visitor to traverse the node.

Implements QgsVbScriptNode.

Definition at line 621 of file qgsvbscript.cpp.

◆ body()

QgsVbScriptBlockStatement * QgsVbScriptForEachStatement::body ( ) const
inline

Returns the loop body block statement.

Definition at line 1003 of file qgsvbscript.h.

◆ clone()

QgsVbScriptNode * QgsVbScriptForEachStatement::clone ( ) const
overridevirtual

Creates a copy of the node.

Caller takes ownership of the returned object.

Implements QgsVbScriptNode.

Definition at line 614 of file qgsvbscript.cpp.

◆ collection()

QgsVbScriptExpression * QgsVbScriptForEachStatement::collection ( ) const
inline

Returns the collection expression being iterated over.

Definition at line 998 of file qgsvbscript.h.

◆ dump()

QString QgsVbScriptForEachStatement::dump ( ) const
overridevirtual

Returns the formatted script representation of the node.

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

Implements QgsVbScriptNode.

Definition at line 609 of file qgsvbscript.cpp.

◆ nodeType()

QgsVbScriptNode::NodeType QgsVbScriptForEachStatement::nodeType ( ) const
inlineoverridevirtual

Returns the node type.

Implements QgsVbScriptNode.

Definition at line 985 of file qgsvbscript.h.

◆ variableName()

QString QgsVbScriptForEachStatement::variableName ( ) const
inline

Returns the loop variable identifier name.

Definition at line 993 of file qgsvbscript.h.


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