Value Relation Widget

src/core/core.pro

@@ -59,7 +59,8 @@ HEADERS += \
     linepolygonhighlight.h \
     qgsgeometrywrapper.h \
     valuemapmodel.h \
-    referencingfeaturelistmodel.h
+    referencingfeaturelistmodel.h \
+    featurechecklistmodel.h
 
 SOURCES += \
     appinterface.cpp \
@@ -102,7 +103,8 @@ SOURCES += \
     linepolygonhighlight.cpp \
     qgsgeometrywrapper.cpp \
     valuemapmodel.cpp \
-    referencingfeaturelistmodel.cpp
+    referencingfeaturelistmodel.cpp \
+    featurechecklistmodel.cpp
 
 INCLUDEPATH += ../../3rdparty/tessellate \
                ../qgsquick \

src/core/featurechecklistmodel.cpp

@@ -0,0 +1,71 @@
+#include "featurechecklistmodel.h"
+
+FeatureCheckListModel::FeatureCheckListModel()
+{
+
+}
+
+QVariant FeatureCheckListModel::data( const QModelIndex &index, int role ) const
+{
+  if ( role == CheckedRole )
+    return mCheckedEntries.contains( FeatureListModel::data( index, FeatureListModel::KeyFieldRole ).toString() );
+  else
+    return FeatureListModel::data( index, role );
+}
+
+bool FeatureCheckListModel::setData( const QModelIndex &index, const QVariant &value, int role )
+{
+  if ( data( index, role ) == value )
+    return true;
+
+  switch ( role )
+  {
+    case CheckedRole:
+    {
+      if ( value.toBool() )
+        setChecked( index );
+      else
+        setUnchecked( index );
+      break;
+    }
+  }
+  return true;
+}
+
+QHash<int, QByteArray> FeatureCheckListModel::roleNames() const
+{
+  QHash<int, QByteArray> roles = FeatureListModel::roleNames();
+
+  roles[CheckedRole] = "checked";
+
+  return roles;
+}
+
+QString FeatureCheckListModel::attributeValue() const
+{
+  return mAttributeValue;
+}
+
+void FeatureCheckListModel::setAttributeValue( const QString &attributeValue )
+{
+  //just for test
+  return;
+
+  if ( mAttributeValue == attributeValue )
+    return;
+
+  mAttributeValue = attributeValue;
+
+  //set mCheckedEntries
+  emit attributeValueChanged();
+}
+
+void FeatureCheckListModel::setChecked( const QModelIndex &index )
+{
+  mCheckedEntries.append( FeatureListModel::data( index, FeatureListModel::KeyFieldRole ).toString() );
+}
+
+void FeatureCheckListModel::setUnchecked( const QModelIndex &index )
+{
+  mCheckedEntries.removeAll( FeatureListModel::data( index, FeatureListModel::KeyFieldRole ).toString() );
+}

src/core/featurechecklistmodel.h

@@ -0,0 +1,55 @@
+#ifndef FEATURECHECKLISTMODEL_H
+#define FEATURECHECKLISTMODEL_H
+
+#include <featurelistmodel.h>
+
+class FeatureCheckListModel : public FeatureListModel
+{
+    Q_OBJECT
+
+    /**
+     * The attribute value
+     */
+    Q_PROPERTY( QString attributeValue READ attributeValue WRITE setAttributeValue NOTIFY attributeValueChanged )
+
+  public:
+    FeatureCheckListModel();
+
+    enum FeatureListRoles
+    {
+      CheckedRole
+    };
+
+    /*
+    virtual QModelIndex index( int row, int column, const QModelIndex &parent ) const override;
+    virtual QModelIndex parent( const QModelIndex &child ) const override;
+    virtual int rowCount( const QModelIndex &parent ) const override;
+    virtual int columnCount( const QModelIndex &parent ) const override;
+    */
+    virtual QVariant data( const QModelIndex &index, int role ) const override;
+    virtual bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
+
+    QHash<int, QByteArray> roleNames() const override;
+
+    /**
+     * the attribute value (hstore or json list)
+     */
+    QString attributeValue() const;
+
+    /**
+     * the attribute value (hstore or json list)
+     */
+    void setAttributeValue( const QString &attributeValue );
+
+  signals:
+    void attributeValueChanged();
+
+  private:
+    void setChecked( const QModelIndex &index );
+    void setUnchecked( const QModelIndex &index );
+
+    QString mAttributeValue;
+    QStringList mCheckedEntries;
+};
+
+#endif // FEATURECHECKLISTMODEL_H

src/core/featurelistmodel.cpp

@@ -16,6 +16,7 @@
 #include "featurelistmodel.h"
 
 #include "qgsvectorlayer.h"
+#include <qgsproject.h>
 
 FeatureListModel::FeatureListModel()
   : mCurrentLayer( nullptr )
@@ -55,7 +56,7 @@ int FeatureListModel::columnCount( const QModelIndex &parent ) const
 
 QVariant FeatureListModel::data( const QModelIndex &index, int role ) const
 {
-  if ( role == Qt::DisplayRole )
+  if ( role == Qt::DisplayRole || role == DisplayStringRole )
     return mEntries.value( index.row() ).displayString;
   else if ( role == KeyFieldRole )
     return mEntries.value( index.row() ).key;
@@ -67,7 +68,8 @@ QHash<int, QByteArray> FeatureListModel::roleNames() const
 {
   QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
 
-  roles[KeyFieldRole] = "keyField";
+  roles[KeyFieldRole] = "keyFieldValue";
+  roles[DisplayStringRole] = "displayString";
 
   return roles;
 }
@@ -118,6 +120,23 @@ void FeatureListModel::setKeyField( const QString &keyField )
   emit keyFieldChanged();
 }
 
+QString FeatureListModel::displayValueField() const
+{
+  return mDisplayValueField;
+}
+
+void FeatureListModel::setDisplayValueField( const QString &displayValueField )
+{
+  if ( mDisplayValueField == displayValueField )
+    return;
+
+  mDisplayValueField = displayValueField;
+
+  reloadLayer();
+
+  emit displayValueFieldChanged();
+}
+
 int FeatureListModel::findKey( const QVariant &key ) const
 {
   int idx = 0;
@@ -142,7 +161,6 @@ void FeatureListModel::onFeatureDeleted()
   reloadLayer();
 }
 
-
 void FeatureListModel::processReloadLayer()
 {
   mEntries.clear();
@@ -165,6 +183,7 @@ void FeatureListModel::processReloadLayer()
   request.setSubsetOfAttributes( referencedColumns, fields );
 
   int keyIndex = fields.indexOf( mKeyField );
+  int displayValueIndex = fields.indexOf( mDisplayValueField );
 
   QgsFeatureIterator iterator = mCurrentLayer->getFeatures( request );
 
@@ -178,7 +197,10 @@ void FeatureListModel::processReloadLayer()
   while ( iterator.nextFeature( feature ) )
   {
     context.setFeature( feature );
-    entries.append( Entry( expression.evaluate( &context ).toString(), feature.attribute( keyIndex ) ) );
+    if ( mDisplayValueField.isEmpty() )
+      entries.append( Entry( expression.evaluate( &context ).toString(), feature.attribute( keyIndex ) ) );
+    else
+      entries.append( Entry( feature.attribute( displayValueIndex ).toString(), feature.attribute( keyIndex ) ) );
   }
 
   if ( mOrderByValue )

src/core/featurelistmodel.h

@@ -25,6 +25,7 @@ class QgsVectorLayer;
  * Provides access to a list of features from a layer.
  * For each feature, the display expression is exposed as DisplayRole
  * and a keyField as KeyFieldRole for a unique identifier.
+ * If a displayValueField is set it replaces the display expression of the layer.
  */
 class FeatureListModel : public QAbstractItemModel
 {
@@ -38,6 +39,10 @@ class FeatureListModel : public QAbstractItemModel
      * The primary key field
      */
     Q_PROPERTY( QString keyField READ keyField WRITE setKeyField NOTIFY keyFieldChanged )
+    /**
+     * The display value field
+     */
+    Q_PROPERTY( QString displayValueField READ displayValueField WRITE setDisplayValueField NOTIFY displayValueFieldChanged )
 
     Q_PROPERTY( bool orderByValue READ orderByValue WRITE setOrderByValue NOTIFY orderByValueChanged )
 
@@ -46,7 +51,8 @@ class FeatureListModel : public QAbstractItemModel
   public:
     enum FeatureListRoles
     {
-      KeyFieldRole = Qt::UserRole + 1
+      KeyFieldRole = Qt::UserRole + 1,
+      DisplayStringRole
     };
 
     Q_ENUM( FeatureListRoles )
@@ -67,6 +73,9 @@ class FeatureListModel : public QAbstractItemModel
     QString keyField() const;
     void setKeyField( const QString &keyField );
 
+    QString displayValueField() const;
+    void setDisplayValueField( const QString &displayValueField );
+
     /**
      * Get the row for a given key value.
      */
@@ -95,6 +104,7 @@ class FeatureListModel : public QAbstractItemModel
   signals:
     void currentLayerChanged();
     void keyFieldChanged();
+    void displayValueFieldChanged();
     void addNullChanged();
     void orderByValueChanged();
 
@@ -134,6 +144,7 @@ class FeatureListModel : public QAbstractItemModel
 
     QList<Entry> mEntries;
     QString mKeyField;
+    QString mDisplayValueField;
     bool mOrderByValue = false;
     bool mAddNull = false;
 

src/core/qgismobileapp.cpp

@@ -86,6 +86,7 @@
 #include "linepolygonhighlight.h"
 #include "valuemapmodel.h"
 #include "referencingfeaturelistmodel.h"
+#include "featurechecklistmodel.h"
 
 QgisMobileapp::QgisMobileapp( QgsApplication *app, QObject *parent )
   : QQmlApplicationEngine( parent )
@@ -157,6 +158,7 @@ void QgisMobileapp::initDeclarative()
   qmlRegisterUncreatableType<QgsUnitTypes>( "org.qgis", 1, 0, "QgsUnitTypes", "" );
   qmlRegisterUncreatableType<QgsRelationManager>( "org.qgis", 1, 0, "RelationManager", "The relation manager is available from the QgsProject. Try `qgisProject.relationManager`" );
   qmlRegisterUncreatableType<QgsWkbTypes>( "org.qgis", 1, 0, "QgsWkbTypes", "" );
+  qmlRegisterUncreatableType<QgsMapLayer>( "org.qgis", 1, 0, "MapLayer", "" );
 
   // Register QgsQuick QML types
   qmlRegisterType<QgsQuickMapCanvasMap>( "org.qgis", 1, 0, "MapCanvasMap" );
@@ -195,6 +197,7 @@ void QgisMobileapp::initDeclarative()
   qmlRegisterType<QgsGeometryWrapper>( "org.qfield", 1, 0, "QgsGeometryWrapper" );
   qmlRegisterType<ValueMapModel>( "org.qfield", 1, 0, "ValueMapModel" );
   qmlRegisterType<ReferencingFeatureListModel>( "org.qgis", 1, 0, "ReferencingFeatureListModel" );
+  qmlRegisterType<FeatureCheckListModel>( "org.qfield", 1, 0, "FeatureCheckListModel" );
 
   qmlRegisterUncreatableType<AppInterface>( "org.qgis", 1, 0, "QgisInterface", "QgisInterface is only provided by the environment and cannot be created ad-hoc" );
   qmlRegisterUncreatableType<Settings>( "org.qgis", 1, 0, "Settings", "" );