mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-03 00:14:12 -05:00
129 lines
3.6 KiB
Plaintext
129 lines
3.6 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsexpressionpreviewwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsExpressionPreviewWidget : QWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
:py:class:`QgsExpressionPreviewWidget` is a widget to preview an expression result.
|
|
If the layer is set, one can browse across features to see the different outputs.
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsexpressionpreviewwidget.h"
|
|
%End
|
|
public:
|
|
explicit QgsExpressionPreviewWidget( QWidget *parent = 0 );
|
|
%Docstring
|
|
Constructor
|
|
%End
|
|
|
|
void setLayer( QgsVectorLayer *layer );
|
|
%Docstring
|
|
Sets the layer used in the preview
|
|
%End
|
|
|
|
void setExpressionText( const QString &expression );
|
|
%Docstring
|
|
Sets the expression
|
|
%End
|
|
|
|
QgsExpressionContext expressionContext() const;
|
|
%Docstring
|
|
Returns the expression context for the widget. 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 widget. The context is used for the expression
|
|
preview result and to populate the list of available functions and variables.
|
|
|
|
:param context: expression context
|
|
%End
|
|
|
|
void setGeomCalculator( const QgsDistanceArea &da );
|
|
%Docstring
|
|
Sets geometry calculator used in distance/area calculations.
|
|
%End
|
|
|
|
bool evalError() const;
|
|
%Docstring
|
|
Will be set to ``True`` if the current expression text reported an eval error
|
|
with the context.
|
|
%End
|
|
|
|
bool parserError() const;
|
|
%Docstring
|
|
Will be set to ``True`` if the current expression text reports a parser error
|
|
with the context.
|
|
%End
|
|
|
|
const QgsExpressionNode *rootNode() const;
|
|
%Docstring
|
|
Returns the root node of the expression
|
|
%End
|
|
|
|
QList<QgsExpression::ParserError> parserErrors() const;
|
|
%Docstring
|
|
Returns the expression parser erros
|
|
%End
|
|
|
|
signals:
|
|
|
|
void expressionParsed( bool isValid );
|
|
%Docstring
|
|
Emitted when the user changes the expression in the widget.
|
|
Users of this widget should connect to this signal to decide if to let the user
|
|
continue.
|
|
|
|
:param isValid: Is ``True`` if the expression the user has typed is valid.
|
|
%End
|
|
|
|
void evalErrorChanged();
|
|
%Docstring
|
|
Will be set to ``True`` if the current expression text reported an eval error
|
|
with the context.
|
|
%End
|
|
|
|
void parserErrorChanged();
|
|
%Docstring
|
|
Will be set to ``True`` if the current expression text reported a parser error
|
|
with the context.
|
|
%End
|
|
|
|
void toolTipChanged( const QString &toolTip );
|
|
%Docstring
|
|
Emitted whenever the tool tip changed
|
|
%End
|
|
|
|
public slots:
|
|
void setCurrentFeature( const QgsFeature &feature );
|
|
%Docstring
|
|
sets the current feature used
|
|
%End
|
|
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsexpressionpreviewwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|