Single variable definition for use within a QgsExpressionContextScope. More...

Public Member Functions
	StaticVariable (const QString &name=QString(), const QVariant &value=QVariant(), bool readOnly=false, bool isStatic=false, const QString &description=QString())
	Constructor for StaticVariable.

Public Attributes
QString	description
	Translated description of variable, for use within expression builder widgets.

bool	isStatic
	A static variable can be cached for the lifetime of a context.

QString	name
	Variable name.

bool	readOnly
	True if variable should not be editable by users.

QVariant	value
	Variable value.

Detailed Description

Single variable definition for use within a QgsExpressionContextScope.

Definition at line 120 of file qgsexpressioncontext.h.

Constructor & Destructor Documentation

QgsExpressionContextScope::StaticVariable::StaticVariable	(	const QString &	name = `QString()`,
		const QVariant &	value = `QVariant()`,
		bool	readOnly = `false`,
		bool	isStatic = `false`,
		const QString &	description = `QString()`
	)

inline

Constructor for StaticVariable.

Parameters

name	variable name (should be unique within the QgsExpressionContextScope)
value	initial variable value
readOnly	`true` if variable should not be editable by users
isStatic	`true` if the variable will not change during the lifteime of an iterator.
description	optional translated description of variable, for use in expression builder widgets

Definition at line 131 of file qgsexpressioncontext.h.

QString QgsExpressionContextScope::StaticVariable::description

Translated description of variable, for use within expression builder widgets.

Definition at line 152 of file qgsexpressioncontext.h.

bool QgsExpressionContextScope::StaticVariable::isStatic

A static variable can be cached for the lifetime of a context.

Definition at line 149 of file qgsexpressioncontext.h.

QString QgsExpressionContextScope::StaticVariable::name

Variable name.

Definition at line 140 of file qgsexpressioncontext.h.

bool QgsExpressionContextScope::StaticVariable::readOnly

True if variable should not be editable by users.

Definition at line 146 of file qgsexpressioncontext.h.

QVariant QgsExpressionContextScope::StaticVariable::value

Variable value.

Definition at line 143 of file qgsexpressioncontext.h.

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