1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexpressionbuilderdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsExpressionBuilderDialog : QDialog
{
%Docstring(signature="appended")
A generic dialog for building expression strings
@remarks This class also shows an example on how to use :py:class:`QgsExpressionBuilderWidget`
%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`
.. versionadded:: 2.12
%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`
.. versionadded:: 2.12
%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.
.. versionadded:: 3.0
%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.
.. versionadded:: 3.0
%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.
.. versionadded:: 3.0
%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();
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsexpressionbuilderdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
