QGIS API Documentation  3.0.2-Girona (307d082)
qgsexpressionbuilderdialog.cpp
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 
17 #include "qgssettings.h"
18 #include "qgsguiutils.h"
19 #include "qgsgui.h"
20 
21 QgsExpressionBuilderDialog::QgsExpressionBuilderDialog( QgsVectorLayer *layer, const QString &startText, QWidget *parent, const QString &key, const QgsExpressionContext &context )
22  : QDialog( parent )
23  , mRecentKey( key )
24 {
25  setupUi( this );
27 
28  connect( builder, &QgsExpressionBuilderWidget::parserErrorChanged, this, &QgsExpressionBuilderDialog::syncOkButtonEnabledState );
29  connect( builder, &QgsExpressionBuilderWidget::evalErrorChanged, this, &QgsExpressionBuilderDialog::syncOkButtonEnabledState );
30 
31  builder->setExpressionContext( context );
32  builder->setLayer( layer );
33  builder->setExpressionText( startText );
34  builder->loadFieldNames();
35  builder->loadRecent( mRecentKey );
36 
37  connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsExpressionBuilderDialog::showHelp );
38 }
39 
41 {
42  return builder;
43 }
44 
46 {
47  builder->setExpressionText( text );
48 }
49 
51 {
52  return builder->expressionText();
53 }
54 
56 {
57  return builder->expressionContext();
58 }
59 
61 {
62  builder->setExpressionContext( context );
63 }
64 
66 {
67  QDialog::done( r );
68 }
69 
71 {
72  builder->saveToRecent( mRecentKey );
73  QDialog::accept();
74 }
75 
77 {
78  // Store in child widget only.
79  builder->setGeomCalculator( da );
80 }
81 
83 {
84  return mAllowEvalErrors;
85 }
86 
88 {
89  if ( allowEvalErrors == mAllowEvalErrors )
90  return;
91 
92  mAllowEvalErrors = allowEvalErrors;
93  syncOkButtonEnabledState();
95 }
96 
97 void QgsExpressionBuilderDialog::showHelp()
98 {
99  QgsHelp::openHelp( QStringLiteral( "working_with_vector/expression.html" ) );
100 }
101 
102 void QgsExpressionBuilderDialog::syncOkButtonEnabledState()
103 {
104  QPushButton *okButton = buttonBox->button( QDialogButtonBox::Ok );
105 
106  if ( builder->parserError() )
107  okButton->setEnabled( false );
108  else if ( !builder->evalError() || mAllowEvalErrors )
109  okButton->setEnabled( true );
110  else
111  okButton->setEnabled( true );
112 }
void setExpressionText(const QString &text)
QgsExpressionBuilderDialog(QgsVectorLayer *layer, const QString &startText=QString(), QWidget *parent SIP_TRANSFERTHIS=nullptr, const QString &key="generic", const QgsExpressionContext &context=QgsExpressionContext())
void evalErrorChanged()
Will be set to true if the current expression text reported an eval error with the context...
QgsExpressionBuilderWidget * expressionBuilder()
The builder widget that is used by the dialog.
static QgsGui * instance()
Returns a pointer to the singleton instance.
Definition: qgsgui.cpp:35
QgsExpressionContext expressionContext() const
Returns the expression context for the dialog.
void setAllowEvalErrors(bool allowEvalErrors)
Allow accepting expressions with evaluation errors.
void allowEvalErrorsChanged()
Allow accepting expressions with evaluation errors.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context for the dialog.
void setGeomCalculator(const QgsDistanceArea &da)
Sets geometry calculator used in distance/area calculations.
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.
void done(int r) override
Is called when the dialog get accepted or rejected Used to save geometry.
static void enableAutoGeometryRestore(QWidget *widget, const QString &key=QString())
Register the widget to allow its position to be automatically saved and restored when open and closed...
Definition: qgsgui.cpp:76
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition: qgshelp.cpp:35
void parserErrorChanged()
Will be set to true if the current expression text reported a parser error with the context...
bool allowEvalErrors() const
Allow accepting invalid expressions.
Represents a vector layer which manages a vector based data sets.