qgsfieldexpressionwidget.h

Go to the documentation of this file.

/***************************************************************************
   qgsfieldexpressionwidget.h
    --------------------------------------
   Date                 : 01.04.2014
   Copyright            : (C) 2014 Denis Rouzaud
   Email                : [email protected]
***************************************************************************
*                                                                         *
*   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 QGSFIELDEXPRESSIONWIDGET_H
#define QGSFIELDEXPRESSIONWIDGET_H
 
#include <memory>
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsdistancearea.h"
#include "qgsexpressioncontext.h"
#include "qgsfieldproxymodel.h"
 
#include <QColor>
#include <QComboBox>
#include <QToolButton>
#include <QWidget>
 
class QgsMapLayer;
class QgsVectorLayer;
class QgsExpressionContextGenerator;
 

class GUI_EXPORT QgsFieldExpressionWidget : public QWidget
{
    Q_OBJECT
    Q_PROPERTY( QString expressionDialogTitle READ expressionDialogTitle WRITE setExpressionDialogTitle )
    Q_PROPERTY( QgsFieldProxyModel::Filters filters READ filters WRITE setFilters )
    Q_PROPERTY( bool allowEmptyFieldName READ allowEmptyFieldName WRITE setAllowEmptyFieldName )
    Q_PROPERTY( bool allowEvalErrors READ allowEvalErrors WRITE setAllowEvalErrors NOTIFY allowEvalErrorsChanged )
    Q_PROPERTY( bool buttonVisible READ buttonVisible WRITE setButtonVisible NOTIFY buttonVisibleChanged )
 
  public:
    explicit QgsFieldExpressionWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setExpressionDialogTitle( const QString &title );

    void appendScope( QgsExpressionContextScope *scope SIP_TRANSFER );

    QString expressionDialogTitle() const { return mExpressionDialogTitle; }

    void setFilters( QgsFieldProxyModel::Filters filters );

    void setAllowEmptyFieldName( bool allowEmpty );

    bool allowEmptyFieldName() const;
 
    void setLeftHandButtonStyle( bool isLeft );

    QgsFieldProxyModel::Filters filters() const { return mFieldProxyModel->filters(); }

    void setGeomCalculator( const QgsDistanceArea &da );

    QString currentField( bool *isExpression = nullptr, bool *isValid = nullptr ) const;

    bool isValidExpression( QString *expressionError = nullptr ) const;

    bool isExpression() const;

    QString currentText() const;

    QString asExpression() const;

    QString expression() const;

    QgsVectorLayer *layer() const;

    void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator );
 
#ifndef SIP_RUN

    void setCustomPreviewGenerator( const QString &label, const QList<QPair<QString, QVariant>> &choices, const std::function<QgsExpressionContext( const QVariant & )> &previewContextGenerator );
#else

    void setCustomPreviewGenerator( const QString &label, const QList<QPair<QString, QVariant>> &choices, SIP_PYCALLABLE );
    //%MethodCode
    Py_XINCREF( a2 );
    Py_BEGIN_ALLOW_THREADS sipCpp->setCustomPreviewGenerator( *a0, *a1, [a2]( const QVariant &value ) -> QgsExpressionContext {
      QgsExpressionContext res;
      SIP_BLOCK_THREADS
      PyObject *s = sipCallMethod( NULL, a2, "D", &value, sipType_QVariant, NULL );
      int state;
      int sipIsError = 0;
      QgsExpressionContext *t1 = reinterpret_cast<QgsExpressionContext *>( sipConvertToType( s, sipType_QgsExpressionContext, 0, SIP_NOT_NONE, &state, &sipIsError ) );
      if ( sipIsError == 0 )
      {
        res = QgsExpressionContext( *t1 );
      }
      sipReleaseType( t1, sipType_QgsExpressionContext, state );
      SIP_UNBLOCK_THREADS
      return res;
    } );
 
    Py_END_ALLOW_THREADS
    //%End
#endif

    bool allowEvalErrors() const;

    void setAllowEvalErrors( bool allowEvalErrors );

    bool buttonVisible() const;

    void setButtonVisible( bool visible );
 
  signals:
    void fieldChanged( const QString &fieldName );

    void fieldChanged( const QString &fieldName, bool isValid );

    void allowEvalErrorsChanged();

    void buttonVisibleChanged();
 
  public slots:

    void setLayer( QgsMapLayer *layer );

    void setRow( int row ) { mCombo->setCurrentIndex( row ); }

    void setField( const QString &fieldName );

    void setFields( const QgsFields &fields );

    void setExpression( const QString &expression );
 
  protected slots:
    void editExpression();

    void expressionEdited( const QString &expression );

    void expressionEditingFinished();
 
    void currentFieldChanged();

    void updateLineEditStyle( const QString &expression = QString() );
 
    bool isExpressionValid( const QString &expressionStr );
 
  protected:
    void changeEvent( QEvent *event ) override;
 
    bool eventFilter( QObject *watched, QEvent *event ) override;
 
  private slots:
    void reloadLayer();
 
    void beforeResetModel();
    void afterResetModel();
 
  private:
    QComboBox *mCombo = nullptr;
    QToolButton *mButton = nullptr;
    QgsFieldProxyModel *mFieldProxyModel = nullptr;
    QString mExpressionDialogTitle;
    std::shared_ptr<const QgsDistanceArea> mDistanceArea;
    QgsExpressionContext mExpressionContext;
    const QgsExpressionContextGenerator *mExpressionContextGenerator = nullptr;
    QString mBackupExpression;
    bool mAllowEvalErrors = false;
 
    QString mCustomPreviewLabel;
    QList<QPair<QString, QVariant>> mCustomChoices;
    std::function<QgsExpressionContext( const QVariant & )> mPreviewContextGenerator;
 
    friend class TestQgsFieldExpressionWidget;
};
 
#endif // QGSFIELDEXPRESSIONWIDGET_H