qgsfeaturelistmodel.h

Go to the documentation of this file.

/***************************************************************************
    qgsfeaturelistmodel.h
    ---------------------
    begin                : February 2013
    copyright            : (C) 2013 by 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 QGSATTRIBUTEEDITORMODEL_H
#define QGSATTRIBUTEEDITORMODEL_H
 
#include "qgis_gui.h"
#include "qgsconditionalstyle.h"
#include "qgsexpression.h"
#include "qgsexpressioncontext.h"
#include "qgsfeature.h"
#include "qgsfeaturemodel.h"
 
#include <QItemSelectionModel>
#include <QPointer>
#include <QSortFilterProxyModel>
#include <QVariant>
 
class QgsAttributeTableFilterModel;
class QgsAttributeTableModel;
class QgsVectorLayerCache;
 
#define QGSFEATURELISTMODEL_CACHE_INDEX 1

class GUI_EXPORT QgsFeatureListModel : public QSortFilterProxyModel, public QgsFeatureModel
{
    Q_OBJECT
 
  public:
    struct FeatureInfo
    {
      public:
        FeatureInfo() = default;

        bool isNew = false;

        bool isEdited = false;
    };
 
    enum Role
    {
      FeatureInfoRole = 0x1000, // Make sure no collisions with roles on QgsAttributeTableModel
      FeatureRole,              
      FeatureWithGeometryRole,  
    };
 
  public:
    explicit QgsFeatureListModel( QgsAttributeTableFilterModel *sourceModel, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Woverloaded-virtual"
#endif
    virtual void setSourceModel( QgsAttributeTableFilterModel *sourceModel );
#ifdef __clang__
#pragma clang diagnostic pop
#endif

    QgsVectorLayerCache *layerCache();
 
    QVariant data( const QModelIndex &index, int role ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;

    void setInjectNull( bool injectNull );

    bool injectNull();
 
    QgsAttributeTableModel *masterModel();

    bool setDisplayExpression( const QString &expression );

    QString parserErrorString();
 
    QString displayExpression() const;
    bool featureByIndex( const QModelIndex &index, QgsFeature &feat );

    QgsFeatureId idxToFid( const QModelIndex &index ) const;

    QModelIndex fidToIdx( QgsFeatureId fid ) const;
 
    QModelIndex mapToSource( const QModelIndex &proxyIndex ) const override;
    QModelIndex mapFromSource( const QModelIndex &sourceIndex ) const override;
 
    virtual QModelIndex mapToMaster( const QModelIndex &proxyIndex ) const;
    virtual QModelIndex mapFromMaster( const QModelIndex &sourceIndex ) const;
 
    virtual QItemSelection mapSelectionFromMaster( const QItemSelection &selection ) const;
    virtual QItemSelection mapSelectionToMaster( const QItemSelection &selection ) const;
 
    QModelIndex parent( const QModelIndex &child ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
 
    QModelIndex fidToIndex( QgsFeatureId fid ) override;
    QModelIndexList fidToIndexList( QgsFeatureId fid );

    bool sortByDisplayExpression() const;

    void setSortByDisplayExpression( bool sortByDisplayExpression, Qt::SortOrder order = Qt::AscendingOrder );
 
  public slots:

    Q_DECL_DEPRECATED void onBeginRemoveRows( const QModelIndex &parent, int first, int last );

    Q_DECL_DEPRECATED void onEndRemoveRows( const QModelIndex &parent, int first, int last );

    Q_DECL_DEPRECATED void onBeginInsertRows( const QModelIndex &parent, int first, int last );

    Q_DECL_DEPRECATED void onEndInsertRows( const QModelIndex &parent, int first, int last );
 
  private slots:
 
    void conditionalStylesChanged();
 
  private:
    mutable QgsExpression mDisplayExpression;
    QgsAttributeTableFilterModel *mFilterModel = nullptr;
    QString mParserErrorString;
    bool mInjectNull = false;
    mutable QgsExpressionContext mExpressionContext;
    mutable QMap<QgsFeatureId, QList<QgsConditionalStyle>> mRowStylesMap;
    bool mSortByDisplayExpression = false;
    QPointer<QgsVectorLayer> mSourceLayer;
};
 
Q_DECLARE_METATYPE( QgsFeatureListModel::FeatureInfo )
 
#endif // QGSATTRIBUTEEDITORMODEL_H