QGIS/python/core/auto_generated/qgsexpressioncontextgenerator.sip.in

50 lines
1.9 KiB
Plaintext
Raw Normal View History

2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsexpressioncontextgenerator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsExpressionContextGenerator
{
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Abstract interface for generating an expression context.
2017-05-14 09:48:41 +02:00
2017-12-15 10:36:55 -04:00
You need to implement this interface in a class and register this class with
2017-12-19 11:43:52 -04:00
:py:func:`QgsFieldExpressionWidget.registerExpressionGenerator()`
2017-05-14 09:48:41 +02:00
2017-12-15 10:36:55 -04:00
This is used for example in QgsPropertyOverrideButton or QgsFieldExpressionWidget
classes which will ask for a new QgsExpressionContext every time the expression
editor is opened. This way they are able to provide an up-to-date expression
editor even when the environment changes.
2017-05-14 09:48:41 +02:00
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsexpressioncontextgenerator.h"
%End
public:
2017-05-14 09:48:41 +02:00
virtual QgsExpressionContext createExpressionContext() const = 0;
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
This method needs to be reimplemented in all classes which implement this interface
and return an expression context.
2017-05-14 09:48:41 +02:00
.. versionadded:: 3.0
%End
virtual ~QgsExpressionContextGenerator();
};
2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsexpressioncontextgenerator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/