qgsexpressionbuilderdialog.h

Go to the documentation of this file.

/***************************************************************************
    qgisexpressionbuilderdialog.h - A generic expression builder dialog.
     --------------------------------------
    Date                 :  29-May-2011
    Copyright            : (C) 2011 by Nathan Woodrow
    Email                : woodrow.nathan at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSEXPRESSIONBUILDERDIALOG_H
#define QGSEXPRESSIONBUILDERDIALOG_H
 
#include "ui_qgsexpressionbuilderdialogbase.h"
 
#include "qgis_gui.h"
#include "qgshelp.h"
 
#include <QDialog>

class GUI_EXPORT QgsExpressionBuilderDialog : public QDialog, private Ui::QgsExpressionBuilderDialogBase
{
    Q_OBJECT
 
    Q_PROPERTY( bool allowEvalErrors READ allowEvalErrors WRITE setAllowEvalErrors NOTIFY allowEvalErrorsChanged )
 
  public:
    QgsExpressionBuilderDialog(
      QgsVectorLayer *layer, const QString &startText = QString(), QWidget *parent SIP_TRANSFERTHIS = nullptr, const QString &key = "generic", const QgsExpressionContext &context = QgsExpressionContext()
    );

    QgsExpressionBuilderWidget *expressionBuilder();
 
    void setExpressionText( const QString &text );
 
    QString expressionText();

    QString expectedOutputFormat();

    void setExpectedOutputFormat( const QString &expected );

    QgsExpressionContext expressionContext() const;

    void setExpressionContext( const QgsExpressionContext &context );

    void setGeomCalculator( const QgsDistanceArea &da );

    bool allowEvalErrors() const;

    void setAllowEvalErrors( bool allowEvalErrors );
 
  signals:

    void allowEvalErrorsChanged();
 
  protected:
    void done( int r ) override;
 
    void accept() override;
    void reject() override;
 
  private:
    const QString mInitialText;
    QString mRecentKey;
    bool mAllowEvalErrors = false;
 
  private slots:
    void showHelp();
    void syncOkButtonEnabledState();
};
 
// clazy:excludeall=qstring-allocations
 
#endif