qgseditorwidgetwrapper.h

Go to the documentation of this file.

/***************************************************************************
    qgseditorwidgetwrapper.h
     --------------------------------------
    Date                 : 20.4.2013
    Copyright            : (C) 2013 Matthias Kuhn
    Email                : matthias at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSEDITORWIDGETWRAPPER_H
#define QGSEDITORWIDGETWRAPPER_H
 
#include <QObject>
#include "qgis_sip.h"
#include <QMap>
#include <QVariant>
 
class QgsVectorLayer;
class QgsField;
 
#include "qgswidgetwrapper.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
 
 
class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper
{
    Q_OBJECT
 
    Q_PROPERTY( bool constraintResultVisible READ constraintResultVisible WRITE setConstraintResultVisible NOTIFY constraintResultVisibleChanged )
    Q_PROPERTY( ConstraintResult constraintResult READ constraintResult NOTIFY constraintStatusChanged )
 
  public:
 
    enum ConstraintResult
    {
      ConstraintResultPass = 0, 
      ConstraintResultFailHard, 
      ConstraintResultFailSoft, 
    };
 
    explicit QgsEditorWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    virtual QVariant value() const = 0;
 
    virtual QStringList additionalFields() const {return QStringList();}
 
    virtual QVariantList additionalFieldValues() const {return QVariantList();}
 
    int fieldIdx() const;
 
    QgsField field() const;
 
    QVariant defaultValue() const;
 
    static QgsEditorWidgetWrapper *fromWidget( QWidget *widget );
 
    static bool isInTable( const QWidget *parent );
 
    void setEnabled( bool enabled ) override;
 
    virtual void showIndeterminateState() {}
 
    void updateConstraint( const QgsFeature &featureContext, QgsFieldConstraints::ConstraintOrigin constraintOrigin = QgsFieldConstraints::ConstraintOriginNotSet );
 
    void updateConstraint( const QgsVectorLayer *layer, int index, const QgsFeature &feature, QgsFieldConstraints::ConstraintOrigin constraintOrigin = QgsFieldConstraints::ConstraintOriginNotSet );
 
    void updateConstraint( QgsEditorWidgetWrapper::ConstraintResult constraintResult, const QString &constraintFailureReason );
 
    bool isValidConstraint() const;
 
    bool isBlockingCommit() const;
 
    QString constraintFailureReason() const;
 
    virtual void setHint( const QString &hintText );
 
    ConstraintResult constraintResult() const;
 
    bool constraintResultVisible() const;
 
    void setConstraintResultVisible( bool constraintResultVisible );
 
  signals:
 
    Q_DECL_DEPRECATED void valueChanged( const QVariant &value );
 
    void valuesChanged( const QVariant &value, const QVariantList &additionalFieldValues = QVariantList() );
 
    void constraintStatusChanged( const QString &constraint, const QString &desc, const QString &err, QgsEditorWidgetWrapper::ConstraintResult status );
 
    void constraintResultVisibleChanged( bool visible );
 
  public slots:
 
    void setFeature( const QgsFeature &feature ) override;
 
    // TODO Q_DECL_DEPRECATED
 
    virtual void setValue( const QVariant &value ) SIP_DEPRECATED;
 
    void setValues( const QVariant &value, const QVariantList &additionalValues );
 
    void emitValueChanged();
 
    virtual void parentFormValueChanged( const QString &attribute, const QVariant &value );
 
  protected:
 
    virtual void updateConstraintWidgetStatus();
 
 
    QgsFeature formFeature() const { return mFormFeature; }
 
    void setFormFeature( const QgsFeature &feature ) { mFormFeature = feature; }
 
    bool setFormFeatureAttribute( const QString &attributeName, const QVariant &attributeValue );
 
  private:
 
    virtual void updateValues( const QVariant &value, const QVariantList &additionalValues = QVariantList() ); //TODO QGIS 4: make it pure virtual
 
    // TODO QGIS 4: remove
    bool isRunningDeprecatedSetValue = false;
 
    int mFieldIdx = -1;
 
    QList<int> mAdditionalFieldIndexes;
 
    QgsFeature mFormFeature;
 
    bool mValidConstraint;
 
    bool mIsBlockingCommit;
 
    QString mConstraintFailureReason;
 
    ConstraintResult mConstraintResult = ConstraintResultPass;
 
    bool mConstraintResultVisible = false;
 
    mutable QVariant mDefaultValue; // Cache default value, we don't want to retrieve different serial numbers if called repeatedly
 
};
 
// We'll use this class inside a QVariant in the widgets properties
Q_DECLARE_METATYPE( QgsEditorWidgetWrapper * )
 
#endif // QGSEDITORWIDGETWRAPPER_H