[FEATURE] constraints on widgets

Author: pblottiere

python/core/qgseditformconfig.sip

@@ -476,6 +476,22 @@ class QgsEditFormConfig : QObject
      */
     void setReadOnly( int idx, bool readOnly = true );
 
+    /**
+     * Returns the constraint expression of a specific field
+     * @param idx The index of the field
+     * @return the expression
+     * @note added in QGIS 2.16
+     */
+    QString constraint( int idx ) const;
+
+    /**
+     * Set the constraint expression for a specific field
+     * @param idx the field index
+     * @param str the constraint expression
+     * @note added in QGIS 2.16
+     */
+    void setConstraint( int idx, const QString& str );
+
     /**
      * Returns if the field at fieldidx should be treated as NOT NULL value
      */

python/gui/editorwidgets/core/qgseditorwidgetwrapper.sip

@@ -88,6 +88,21 @@ class QgsEditorWidgetWrapper : QgsWidgetWrapper
      */
     virtual void showIndeterminateState();
 
+    /**
+     * Update constraint.
+     * @param featureContext the feature to use to evaluate the constraint
+     * @note added in QGIS 2.16
+     */
+    void updateConstraint( const QgsFeature &featureContext );
+
+    /**
+     * Get the current constraint status.
+     * @return true if the constraint is valid or if there's not constraint,
+     * false otherwise
+     * @note added in QGIS 2.16
+     */
+    bool isValidConstraint() const;
+
   signals:
     /**
      * Emit this signal, whenever the value changed.
@@ -96,6 +111,13 @@ class QgsEditorWidgetWrapper : QgsWidgetWrapper
      */
     void valueChanged( const QVariant& value );
 
+    /**
+     * @brief constraintStatusChanged
+     * @param constraint
+     * @param status
+     */
+    void constraintStatusChanged( const QString& constraint, const QString& err, bool status );
+
   public slots:
     /**
      * Will be called when the feature changes
@@ -162,4 +184,17 @@ class QgsEditorWidgetWrapper : QgsWidgetWrapper
      * Will call the value() method to determine the emitted value
      */
     void valueChanged();
+
+  protected:
+    /**
+     * This should update the widget with a visual cue if a constraint status
+     * changed.
+     *
+     * By default a stylesheet will be applied on the widget that changes the
+     * background color to red.
+     *
+     * This can be overwritten in subclasses to allow individual widgets to
+     * change the visual cue.
+     */
+    virtual void updateConstraintWidgetStatus();
 };

python/gui/editorwidgets/qgsrelationreferencewidgetwrapper.sip

@@ -21,4 +21,18 @@ class QgsRelationReferenceWidgetWrapper : QgsEditorWidgetWrapper
   public slots:
     virtual void setValue( const QVariant& value );
     virtual void setEnabled( bool enabled );
+
+  protected:
+    /**
+     * This should update the widget with a visual cue if a constraint status
+     * changed.
+     *
+     * By default a stylesheet will be applied on the widget that changes the
+     * background color to red.
+     *
+     * This can be overwritten in subclasses to allow individual widgets to
+     * change the visual cue.
+     * @note added in QGIS 2.16
+     */
+    void updateConstraintWidgetStatus();
 };

src/app/qgsattributetypedialog.cpp

@@ -71,6 +71,8 @@ QgsAttributeTypeDialog::QgsAttributeTypeDialog( QgsVectorLayer *vl, int fieldIdx
 
   QSettings settings;
   restoreGeometry( settings.value( "/Windows/QgsAttributeTypeDialog/geometry" ).toByteArray() );
+
+  constraintExpression->setLayer( vl );
 }
 
 QgsAttributeTypeDialog::~QgsAttributeTypeDialog()
@@ -183,6 +185,16 @@ bool QgsAttributeTypeDialog::notNull() const
   return notNullCheckBox->isChecked();
 }
 
+void QgsAttributeTypeDialog::setConstraint( const QString &str )
+{
+  constraintExpression->setField( str );
+}
+
+QString QgsAttributeTypeDialog::constraint() const
+{
+  return constraintExpression->asExpression();
+}
+
 void QgsAttributeTypeDialog::setFieldEditable( bool editable )
 {
   isFieldEditableCheckBox->setChecked( editable );

src/app/qgsattributetypedialog.h

@@ -94,6 +94,18 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut
      */
     bool notNull() const;
 
+    /**
+     * Getter for the constraint expression
+     * @note added in QGIS 2.16
+     */
+    QString constraint() const;
+
+    /**
+     * Setter for the constraint expression
+     * @note added in QGIS 2.16
+     */
+    void setConstraint( const QString &str );
+
   private slots:
     /**
      * Slot to handle change of index in combobox to select correct page

src/app/qgsfieldsproperties.cpp

@@ -528,6 +528,7 @@ void QgsFieldsProperties::attributeTypeDialog()
   attributeTypeDialog.setFieldEditable( cfg.mEditable );
   attributeTypeDialog.setLabelOnTop( cfg.mLabelOnTop );
   attributeTypeDialog.setNotNull( cfg.mNotNull );
+  attributeTypeDialog.setConstraint( cfg.mConstraint );
 
   attributeTypeDialog.setWidgetV2Config( cfg.mEditorWidgetV2Config );
   attributeTypeDialog.setWidgetV2Type( cfg.mEditorWidgetV2Type );
@@ -538,6 +539,7 @@ void QgsFieldsProperties::attributeTypeDialog()
   cfg.mEditable = attributeTypeDialog.fieldEditable();
   cfg.mLabelOnTop = attributeTypeDialog.labelOnTop();
   cfg.mNotNull = attributeTypeDialog.notNull();
+  cfg.mConstraint = attributeTypeDialog.constraint();
 
   cfg.mEditorWidgetV2Type = attributeTypeDialog.editorWidgetV2Type();
   cfg.mEditorWidgetV2Config = attributeTypeDialog.editorWidgetV2Config();
@@ -911,6 +913,7 @@ void QgsFieldsProperties::apply()
     mLayer->editFormConfig()->setReadOnly( i, !cfg.mEditable );
     mLayer->editFormConfig()->setLabelOnTop( i, cfg.mLabelOnTop );
     mLayer->editFormConfig()->setNotNull( i, cfg.mNotNull );
+    mLayer->editFormConfig()->setConstraint( i, cfg.mConstraint );
 
     mLayer->editFormConfig()->setWidgetType( idx, cfg.mEditorWidgetV2Type );
     mLayer->editFormConfig()->setWidgetConfig( idx, cfg.mEditorWidgetV2Config );
@@ -990,6 +993,7 @@ QgsFieldsProperties::FieldConfig::FieldConfig( QgsVectorLayer* layer, int idx )
                      && layer->fields().fieldOrigin( idx ) != QgsFields::OriginExpression;
   mLabelOnTop = layer->editFormConfig()->labelOnTop( idx );
   mNotNull = layer->editFormConfig()->notNull( idx );
+  mConstraint = layer->editFormConfig()->constraint( idx );
   mEditorWidgetV2Type = layer->editFormConfig()->widgetType( idx );
   mEditorWidgetV2Config = layer->editFormConfig()->widgetConfig( idx );
 

src/app/qgsfieldsproperties.h

@@ -93,6 +93,7 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope
         bool mEditableEnabled;
         bool mLabelOnTop;
         bool mNotNull;
+        QString mConstraint;
         QPushButton* mButton;
         QString mEditorWidgetV2Type;
         QMap<QString, QVariant> mEditorWidgetV2Config;

src/core/qgseditformconfig.cpp

@@ -119,6 +119,22 @@ bool QgsEditFormConfig::labelOnTop( int idx ) const
     return false;
 }
 
+QString QgsEditFormConfig::constraint( int idx ) const
+{
+  QString expr = "";
+
+  if ( idx >= 0 && idx < mFields.count() )
+    expr = mConstraints.value( mFields.at( idx ).name(), "" );
+
+  return expr;
+}
+
+void QgsEditFormConfig::setConstraint( int idx, const QString& str )
+{
+  if ( idx >= 0 && idx < mFields.count() )
+    mConstraints[ mFields.at( idx ).name()] = str;
+}
+
 bool QgsEditFormConfig::notNull( int idx ) const
 {
   if ( idx >= 0 && idx < mFields.count() )

src/core/qgseditformconfig.h

@@ -512,6 +512,22 @@ class CORE_EXPORT QgsEditFormConfig : public QObject
      */
     void setReadOnly( int idx, bool readOnly = true );
 
+    /**
+     * Returns the constraint expression of a specific field
+     * @param idx The index of the field
+     * @return the expression
+     * @note added in QGIS 2.16
+     */
+    QString constraint( int idx ) const;
+
+    /**
+     * Set the constraint expression for a specific field
+     * @param idx the field index
+     * @param str the constraint expression
+     * @note added in QGIS 2.16
+     */
+    void setConstraint( int idx, const QString& str );
+
     /**
      * Returns if the field at fieldidx should be treated as NOT NULL value
      */
@@ -640,6 +656,7 @@ class CORE_EXPORT QgsEditFormConfig : public QObject
     /** Map that stores the tab for attributes in the edit form. Key is the tab order and value the tab name*/
     QList< TabData > mTabs;
 
+    QMap< QString, QString> mConstraints;
     QMap< QString, bool> mFieldEditables;
     QMap< QString, bool> mLabelOnTop;
     QMap< QString, bool> mNotNull;

src/gui/editorwidgets/core/qgseditorwidgetregistry.cpp

@@ -252,6 +252,8 @@ void QgsEditorWidgetRegistry::readMapLayer( QgsMapLayer* mapLayer, const QDomEle
       vectorLayer->editFormConfig()->setReadOnly( idx, ewv2CfgElem.attribute( "fieldEditable", "1" ) != "1" );
       vectorLayer->editFormConfig()->setLabelOnTop( idx, ewv2CfgElem.attribute( "labelOnTop", "0" ) == "1" );
       vectorLayer->editFormConfig()->setNotNull( idx, ewv2CfgElem.attribute( "notNull", "0" ) == "1" );
+      vectorLayer->editFormConfig()->setConstraint( idx, ewv2CfgElem.attribute( "constraint", "" ) );
+
       vectorLayer->editFormConfig()->setWidgetConfig( idx, cfg );
     }
     else
@@ -309,6 +311,7 @@ void QgsEditorWidgetRegistry::writeMapLayer( QgsMapLayer* mapLayer, QDomElement&
       ewv2CfgElem.setAttribute( "fieldEditable", !vectorLayer->editFormConfig()->readOnly( idx ) );
       ewv2CfgElem.setAttribute( "labelOnTop", vectorLayer->editFormConfig()->labelOnTop( idx ) );
       ewv2CfgElem.setAttribute( "notNull", vectorLayer->editFormConfig()->notNull( idx ) );
+      ewv2CfgElem.setAttribute( "constraint", vectorLayer->editFormConfig()->constraint( idx ) );
 
       mWidgetFactories[widgetType]->writeConfig( vectorLayer->editFormConfig()->widgetConfig( idx ), ewv2CfgElem, doc, vectorLayer, idx );