QgsExpressionFieldBuffer Class Reference

Buffers information about expression fields for a vector layer. More...

#include <qgsexpressionfieldbuffer.h>

Classes
struct	ExpressionField

Public Types
typedef struct QgsExpressionFieldBuffer::ExpressionField	ExpressionField

Public Member Functions
	QgsExpressionFieldBuffer ()
void	addExpression (const QString &exp, const QgsField &fld)
	Add an expression to the buffer. More...
const QList< ExpressionField > &	expressions () const
void	readXml (const QDomNode &layer_node)
	Reads expressions from project file. More...
void	removeExpression (int index)
	Remove an expression from the buffer. More...
void	renameExpression (int index, const QString &name)
	Renames an expression field at a given index. More...
void	updateExpression (int index, const QString &exp)
	Changes the expression at a given index. More...
void	updateFields (QgsFields &flds)
	Adds fields with the expressions buffered in this object to a QgsFields object. More...
void	writeXml (QDomNode &layer_node, QDomDocument &document) const
	Saves expressions to xml under the layer node. More...

Detailed Description

Buffers information about expression fields for a vector layer.

Note

added in 2.6

Definition at line 33 of file qgsexpressionfieldbuffer.h.

Member Typedef Documentation

ExpressionField

typedef struct QgsExpressionFieldBuffer::ExpressionField QgsExpressionFieldBuffer::ExpressionField

Constructor & Destructor Documentation

QgsExpressionFieldBuffer()

QgsExpressionFieldBuffer::QgsExpressionFieldBuffer

(

)

Definition at line 22 of file qgsexpressionfieldbuffer.cpp.

Member Function Documentation

addExpression()

void QgsExpressionFieldBuffer::addExpression	(	const QString &	exp,
		const QgsField &	fld
	)

Add an expression to the buffer.

Parameters

exp	expression to add
fld	field to add

Definition at line 26 of file qgsexpressionfieldbuffer.cpp.

expressions()

const QList<ExpressionField>& QgsExpressionFieldBuffer::expressions ( ) const

inline

Definition at line 107 of file qgsexpressionfieldbuffer.h.

readXml()

void QgsExpressionFieldBuffer::readXml

(

const QDomNode &

layer_node

)

Reads expressions from project file.

Definition at line 68 of file qgsexpressionfieldbuffer.cpp.

removeExpression()

void QgsExpressionFieldBuffer::removeExpression

(

int

index

)

Remove an expression from the buffer.

Parameters

index

index of expression to remove

Definition at line 31 of file qgsexpressionfieldbuffer.cpp.

renameExpression()

void QgsExpressionFieldBuffer::renameExpression	(	int	index,
		const QString &	name
	)

Renames an expression field at a given index.

Parameters

index	The index of the expression to change
name	New name for field

Note

added in 3.0

Definition at line 36 of file qgsexpressionfieldbuffer.cpp.

updateExpression()

void QgsExpressionFieldBuffer::updateExpression	(	int	index,
		const QString &	exp
	)

Changes the expression at a given index.

Parameters

index	The index of the expression to change
exp	The new expression to set

Note

added in 2.9

Definition at line 41 of file qgsexpressionfieldbuffer.cpp.

updateFields()

void QgsExpressionFieldBuffer::updateFields

(

QgsFields &

flds

)

Adds fields with the expressions buffered in this object to a QgsFields object.

Parameters

flds	The fields to be updated

Definition at line 94 of file qgsexpressionfieldbuffer.cpp.

writeXml()

void QgsExpressionFieldBuffer::writeXml	(	QDomNode &	layer_node,
		QDomDocument &	document
	)		const

Saves expressions to xml under the layer node.

Definition at line 47 of file qgsexpressionfieldbuffer.cpp.

---

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

• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsexpressionfieldbuffer.h
• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsexpressionfieldbuffer.cpp