Value Relation Widget

.travis.yml

@@ -19,7 +19,7 @@ before_install:
   - gem --version
 
 script:
-  - export QFIELD_SDK_VERSION=${QFIELD_SDK_VERSION:-20190528}
+  - export QFIELD_SDK_VERSION=${QFIELD_SDK_VERSION:-20190726}
   - echo "travis_fold:start:docker-pull"
   - docker pull opengisch/qfield-sdk:${QFIELD_SDK_VERSION}
   - echo "travis_fold:end:docker-pull"

qfield.pri

@@ -35,10 +35,8 @@ android {
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libzip.so \
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libspatialiteprovider.so \
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libdelimitedtextprovider.so \
-    $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libgdalprovider.so \
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libgpxprovider.so \
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libmssqlprovider.so \
-    $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libogrprovider.so \
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libowsprovider.so \
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libpostgresprovider.so \
     $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libspatialiteprovider.so \
@@ -51,5 +49,16 @@ android {
     $$QT_LIBS_DIR/libQt5Sql.so \
     $$QT_LIBS_DIR/libQt5Svg.so \
     $$QT_LIBS_DIR/libQt5PrintSupport.so
-}
 
+    # Only here for Android 5 (QGIS <= 3.8) compatibility reasons
+    exists ( $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libgdalprovider.so ) {
+      ANDROID_EXTRA_LIBS += \
+        $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libgdalprovider.so
+    }
+
+    # Only here for Android 5 (QGIS <= 3.8) compatibility reasons
+    exists ( $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libogrprovider.so ) {
+      ANDROID_EXTRA_LIBS += \
+        $${OSGEO4A_STAGE_DIR}/$$ANDROID_TARGET_ARCH$$/lib/libogrprovider.so
+    }
+}

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,178 @@
+/***************************************************************************
+  featurechecklistmodel.cpp - FeatureCheckListModel
+
+ ---------------------
+ begin                : August 2019
+ copyright            : (C) 2019 by David Signer
+ email                : david (at) opengis.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.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#include "featurechecklistmodel.h"
+#include "qgsvaluerelationfieldformatter.h"
+#include "qgsmessagelog.h"
+#if VERSION_INT >= 30600
+#include "qgspostgresstringutils.h"
+#endif
+
+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;
+}
+
+QVariant FeatureCheckListModel::attributeValue() const
+{
+  QVariant value;
+
+  QVariantList vl;
+  //store as QVariantList because the field type supports data structure
+  for ( const QString &s : qgis::as_const( mCheckedEntries ) )
+  {
+    // Convert to proper type
+    const QVariant::Type type { fkType() };
+    switch ( type )
+    {
+      case QVariant::Type::Int:
+        vl.push_back( s.toInt() );
+        break;
+      case QVariant::Type::LongLong:
+        vl.push_back( s.toLongLong() );
+        break;
+      default:
+        vl.push_back( s );
+        break;
+    }
+  }
+
+  if ( mAttributeField.type() == QVariant::Map ||
+       mAttributeField.type() == QVariant::List )
+  {
+    value = vl;
+  }
+  else
+  {
+    //make string
+#if VERSION_INT >= 30600
+    value = QgsPostgresStringUtils::buildArray( vl );
+#else
+    QgsMessageLog::logMessage( tr( "Storing of value relation widget checklists not available for Android 5" ), "QField", Qgis::Critical );
+#endif
+  }
+
+  return value;
+}
+
+void FeatureCheckListModel::setAttributeValue( const QVariant &attributeValue )
+{
+  QStringList checkedEntries;
+
+  if ( mAttributeField.type() == QVariant::Map )
+  {
+    //store as QVariantList because the field type supports data structure
+    checkedEntries = attributeValue.toStringList();
+  }
+  else
+  {
+    //store as a formatted string because the fields supports only string
+    checkedEntries = QgsValueRelationFieldFormatter::valueToStringList( attributeValue );
+  }
+
+  if ( mCheckedEntries == checkedEntries )
+    return;
+
+  beginResetModel();
+  mCheckedEntries = checkedEntries;
+  endResetModel();
+
+  emit attributeValueChanged();
+}
+
+QgsField FeatureCheckListModel::attributeField() const
+{
+  return mAttributeField;
+}
+
+void FeatureCheckListModel::setAttributeField( const QgsField &field )
+{
+  if ( mAttributeField == field )
+    return;
+
+  mAttributeField = field;
+}
+
+void FeatureCheckListModel::setChecked( const QModelIndex &index )
+{
+  beginResetModel();
+  mCheckedEntries.append( FeatureListModel::data( index, FeatureListModel::KeyFieldRole ).toString() );
+  endResetModel();
+
+  emit listUpdated();
+}
+
+void FeatureCheckListModel::setUnchecked( const QModelIndex &index )
+{
+  beginResetModel();
+  mCheckedEntries.removeAll( FeatureListModel::data( index, FeatureListModel::KeyFieldRole ).toString() );
+  endResetModel();
+
+  emit listUpdated();
+}
+
+
+QVariant::Type FeatureCheckListModel::fkType() const
+{
+  if ( currentLayer() )
+  {
+    QgsFields fields = currentLayer()->fields();
+    int idx { fields.indexOf( keyField() ) };
+    if ( idx >= 0 )
+    {
+      return fields.at( idx ).type();
+    }
+  }
+  return QVariant::Type::Invalid;
+}

src/core/featurechecklistmodel.h

@@ -0,0 +1,84 @@
+/***************************************************************************
+  featurechecklistmodel.h - FeatureCheckListModel
+
+ ---------------------
+ begin                : August 2019
+ copyright            : (C) 2019 by David Signer
+ email                : david (at) opengis.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 FEATURECHECKLISTMODEL_H
+#define FEATURECHECKLISTMODEL_H
+
+#include <featurelistmodel.h>
+#include <qgsvectorlayer.h>
+
+class FeatureCheckListModel : public FeatureListModel
+{
+    Q_OBJECT
+
+    /**
+     * The attribute value to generate checklist
+     */
+    Q_PROPERTY( QVariant attributeValue READ attributeValue WRITE setAttributeValue NOTIFY attributeValueChanged )
+
+    /**
+     * The attribute field to have information about type (JSON/HSTORE) etc.
+     */
+    Q_PROPERTY( QgsField attributeField READ attributeField WRITE setAttributeField NOTIFY attributeFieldChanged )
+
+  public:
+    FeatureCheckListModel();
+
+    enum FeatureListRoles
+    {
+      CheckedRole
+    };
+
+    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. A QVariantList or an hstore formatted string, depending on the field type.
+     */
+    QVariant attributeValue() const;
+
+    /**
+     * the attribute value. A QVariantList or an hstore formatted string, depending on the field type.
+     */
+    void setAttributeValue( const QVariant &attributeValue );
+
+    /**
+     * the current attribute field
+     */
+    QgsField attributeField() const;
+
+    /**
+     * the current attribute field
+     */
+    void setAttributeField( const QgsField &field );
+
+  signals:
+    void attributeValueChanged();
+    void attributeFieldChanged();
+    void listUpdated();
+
+  private:
+    void setChecked( const QModelIndex &index );
+    void setUnchecked( const QModelIndex &index );
+    QVariant::Type fkType() const;
+
+    QgsField mAttributeField;
+    QStringList mCheckedEntries;
+};
+
+#endif // FEATURECHECKLISTMODEL_H