QGIS API Documentation  3.13.0-Master (740be229cb)
qgsexpressionbuilderdialog.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgisexpressionbuilderdialog.h - A generic expression string builder dialog.
3  --------------------------------------
4  Date : 29-May-2011
5  Copyright : (C) 2011 by Nathan Woodrow
6  Email : woodrow.nathan at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSEXPRESSIONBUILDERDIALOG_H
17 #define QGSEXPRESSIONBUILDERDIALOG_H
18 
19 #include <QDialog>
20 #include "ui_qgsexpressionbuilderdialogbase.h"
21 #include "qgshelp.h"
22 #include "qgis_gui.h"
23 
24 
30 class GUI_EXPORT QgsExpressionBuilderDialog : public QDialog, private Ui::QgsExpressionBuilderDialogBase
31 {
32  Q_OBJECT
33 
34  Q_PROPERTY( bool allowEvalErrors READ allowEvalErrors WRITE setAllowEvalErrors NOTIFY allowEvalErrorsChanged )
35 
36  public:
38  const QString &startText = QString(),
39  QWidget *parent SIP_TRANSFERTHIS = nullptr,
40  const QString &key = "generic",
41  const QgsExpressionContext &context = QgsExpressionContext() );
42 
44  QgsExpressionBuilderWidget *expressionBuilder();
45 
46  void setExpressionText( const QString &text );
47 
48  QString expressionText();
49 
56  QString expectedOutputFormat();
57 
63  void setExpectedOutputFormat( const QString &expected );
64 
71  QgsExpressionContext expressionContext() const;
72 
80  void setExpressionContext( const QgsExpressionContext &context );
81 
83  void setGeomCalculator( const QgsDistanceArea &da );
84 
91  bool allowEvalErrors() const;
92 
99  void setAllowEvalErrors( bool allowEvalErrors );
100 
101  signals:
102 
109  void allowEvalErrorsChanged();
110 
111  protected:
112 
119  void done( int r ) override;
120 
121  void accept() override;
122 
123  private:
124  QString mRecentKey;
125  bool mAllowEvalErrors = false;
126 
127  private slots:
128  void showHelp();
129  void syncOkButtonEnabledState();
130 
131 };
132 
133 // clazy:excludeall=qstring-allocations
134 
135 #endif
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
A general purpose distance and area calculator, capable of performing ellipsoid based calculations...
A reusable widget that can be used to build a expression string.
Represents a vector layer which manages a vector based data sets.
A generic dialog for building expression strings.