QGIS/python/gui/auto_generated/qgsexpressionbuilderdialog.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

121 lines
3.8 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexpressionbuilderdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsExpressionBuilderDialog : QDialog
{
%Docstring(signature="appended")
A generic dialog for building expression strings.
%End
%TypeHeaderCode
#include "qgsexpressionbuilderdialog.h"
%End
public:
QgsExpressionBuilderDialog( QgsVectorLayer *layer, const QString &startText = QString(), QWidget *parent /TransferThis/ = 0, const QString &key = "generic", const QgsExpressionContext &context = QgsExpressionContext() );
QgsExpressionBuilderWidget *expressionBuilder();
%Docstring
The builder widget that is used by the dialog
%End
void setExpressionText( const QString &text );
QString expressionText();
QString expectedOutputFormat();
%Docstring
Returns the expected format string, which is shown in the dialog. This
is purely a text format and no expression validation is done against it.
.. seealso:: :py:func:`setExpectedOutputFormat`
%End
void setExpectedOutputFormat( const QString &expected );
%Docstring
Set the ``expected`` format string, which is shown in the dialog. This
is purely a text format and no expression validation is done against it.
.. seealso:: :py:func:`expectedOutputFormat`
%End
QgsExpressionContext expressionContext() const;
%Docstring
Returns the expression context for the dialog. The context is used for
the expression preview result and for populating the list of available
functions and variables.
.. seealso:: :py:func:`setExpressionContext`
%End
void setExpressionContext( const QgsExpressionContext &context );
%Docstring
Sets the expression context for the dialog. The context is used for the
expression preview result and for populating the list of available
functions and variables.
:param context: expression context
.. seealso:: :py:func:`expressionContext`
%End
void setGeomCalculator( const QgsDistanceArea &da );
%Docstring
Sets geometry calculator used in distance/area calculations.
%End
bool allowEvalErrors() const;
%Docstring
Allow accepting invalid expressions. This can be useful when we are not
able to provide an expression context of which we are sure it's
completely populated.
%End
void setAllowEvalErrors( bool allowEvalErrors );
%Docstring
Allow accepting expressions with evaluation errors. This can be useful
when we are not able to provide an expression context of which we are
sure it's completely populated.
%End
signals:
void allowEvalErrorsChanged();
%Docstring
Allow accepting expressions with evaluation errors. This can be useful
when we are not able to provide an expression context of which we are
sure it's completely populated.
%End
protected:
virtual void done( int r );
%Docstring
Is called when the dialog get accepted or rejected Used to save geometry
:param r: result value (unused)
%End
virtual void accept();
virtual void reject();
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexpressionbuilderdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/