QGIS/python/gui/auto_generated/vector/qgsfieldcalculator.sip.in
jakimowb d7bf988817
Expose QgsFieldCalculator to public API (#46748)
* shows QgsFieldCalculator in public API

* removed unnecessary comment

* QgsFieldCalculator:
made public slots private and added code documentation

* fixed doc string

* Apply suggestions from code review

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>

* updated sip file

Co-authored-by: Nyall Dawson <nyall.dawson@gmail.com>
2022-01-08 16:28:27 +01:00

55 lines
1.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/vector/qgsfieldcalculator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsFieldCalculator: QDialog
{
%Docstring(signature="appended")
A dialog class that provides calculation of new fields using existing fields, values and a set of operators
Sample usage of the :py:class:`QgsFieldCalculator` class:
.. code-block:: python
uri = "point?crs=epsg:4326&field=id:integer"
layer = QgsVectorLayer(uri, "Scratch point layer", "memory")
layer.startEditing()
dialog = QgsFieldCalculator(layer)
dialog.exec_()
%End
%TypeHeaderCode
#include "qgsfieldcalculator.h"
%End
public:
QgsFieldCalculator( QgsVectorLayer *vl, QWidget *parent = 0 );
int changedAttributeId() const;
%Docstring
Returns the field index of the field for which new attribute values were calculated.
:return: The field index if attribute values were calculated or -1, e.g. in case of geometry changes.
%End
public slots:
virtual void accept();
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/vector/qgsfieldcalculator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/