QGIS/python/core/auto_generated/qgsexpressionfieldbuffer.sip.in
2024-08-13 20:28:55 +10:00

92 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsexpressionfieldbuffer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsExpressionFieldBuffer
{
%Docstring(signature="appended")
Buffers information about expression fields for a vector layer.
%End
%TypeHeaderCode
#include "qgsexpressionfieldbuffer.h"
%End
public:
struct ExpressionField
{
ExpressionField( const QString &exp, const QgsField &fld );
QgsExpression cachedExpression;
QgsField field;
};
QgsExpressionFieldBuffer();
void addExpression( const QString &exp, const QgsField &fld );
%Docstring
Add an expression to the buffer
:param exp: expression to add
:param fld: field to add
%End
void removeExpression( int index );
%Docstring
Remove an expression from the buffer
:param index: index of expression to remove
%End
void renameExpression( int index, const QString &name );
%Docstring
Renames an expression field at a given index
:param index: The index of the expression to change
:param name: New name for field
%End
void updateExpression( int index, const QString &exp );
%Docstring
Changes the expression at a given index
:param index: The index of the expression to change
:param exp: The new expression to set
%End
void writeXml( QDomNode &layer_node, QDomDocument &document ) const;
%Docstring
Saves expressions to xml under the layer node
%End
void readXml( const QDomNode &layer_node );
%Docstring
Reads expressions from project file
%End
void updateFields( QgsFields &flds ) const;
%Docstring
Adds fields with the expressions buffered in this object to a :py:class:`QgsFields` object
:param flds: The fields to be updated
%End
QList<QgsExpressionFieldBuffer::ExpressionField> expressions() const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsexpressionfieldbuffer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/