qgsquickfeatureslistmodel.h

Go to the documentation of this file.

/***************************************************************************
  qgsquickfeatureslistmodel.h
 ---------------------------
  Date                 : Sep 2020
  Copyright            : (C) 2020 by Tomas Mizera
  Email                : tomas.mizera2 at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSQUICKFEATURESMODEL_H
#define QGSQUICKFEATURESMODEL_H
 
#include <QAbstractListModel>
 
#include "qgsvectorlayer.h"
#include "qgsquickfeaturelayerpair.h"
#include "qgsvaluerelationfieldformatter.h"
 
class QUICK_EXPORT QgsQuickFeaturesListModel : public QAbstractListModel
{
    Q_OBJECT
 
    Q_PROPERTY( int featuresCount READ featuresCount NOTIFY featuresCountChanged )
 
    
    Q_PROPERTY( QString searchExpression READ searchExpression WRITE setSearchExpression NOTIFY searchExpressionChanged )
 
    
    Q_PROPERTY( int featuresLimit READ featuresLimit NOTIFY featuresLimitChanged )
 
    
    Q_PROPERTY( QgsFeature currentFeature READ currentFeature WRITE setCurrentFeature NOTIFY currentFeatureChanged )
 
  public:
 
    enum modelRoles
    {
      FeatureTitle = Qt::UserRole + 1,
      FeatureId,
      Feature,
      Description, 
      KeyColumn, 
      FoundPair 
    };
    Q_ENUM( modelRoles );
 
    explicit QgsQuickFeaturesListModel( QObject *parent = nullptr );
    ~QgsQuickFeaturesListModel() override;
 
    Q_INVOKABLE QgsQuickFeatureLayerPair featureLayerPair( const int &featureId );
 
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    QHash<int, QByteArray> roleNames() const override;
 
    Q_INVOKABLE void setupValueRelation( const QVariantMap &config );
 
    Q_INVOKABLE void populateFromLayer( QgsVectorLayer *layer );
 
    Q_INVOKABLE void reloadFeatures();
 
    Q_INVOKABLE int rowFromAttribute( const int role, const QVariant &value ) const;
 
    Q_INVOKABLE QVariant attributeFromValue( const int role, const QVariant &value, const int requestedRole ) const;
 
    Q_INVOKABLE QVariant convertMultivalueFormat( const QVariant &multivalue, const int requestedRole = Qt::DisplayRole );
 
    int featuresLimit() const;
    int featuresCount() const;
    QString searchExpression() const;
 
    void setSearchExpression( const QString &searchExpression );
 
    void setFeatureTitleField( const QString &attribute );
 
    void setKeyField( const QString &attribute );
 
    void setFilterExpression( const QString &filterExpression );
 
    void setCurrentFeature( QgsFeature feature );
 
    QgsFeature currentFeature() const;
 
  signals:
 
    void featuresCountChanged( int featuresCount );
 
    void featuresLimitChanged( int featuresLimit );
 
    void searchExpressionChanged( QString searchExpression );
 
    void currentFeatureChanged( QgsFeature feature );
 
  private:
 
    void setupFeatureRequest( QgsFeatureRequest &request );
 
    void loadFeaturesFromLayer( QgsVectorLayer *layer = nullptr );
 
    void emptyData();
 
    QVariant featureTitle( const QgsQuickFeatureLayerPair &featurePair ) const;
 
    QString buildSearchExpression();
 
    QString foundPair( const QgsQuickFeatureLayerPair &feat ) const;
 
    QgsQuickFeatureLayerPairs mFeatures;
 
    const int FEATURES_LIMIT = 10000;
 
    QString mSearchExpression;
 
    QString mFilterExpression;
 
    QgsVectorLayer *mCurrentLayer = nullptr;
 
    QgsFeature mCurrentFeature;
 
    QString mKeyField;
 
    QString mFeatureTitleField;
};
 
#endif // QGSQUICKFEATURESMODEL_H