qgsattributetablemodel.h

Go to the documentation of this file.

/***************************************************************************
  QgsAttributeTableModel.h - Models for attribute table
  -------------------
         date                 : Feb 2009
         copyright            : (C) 2009 by Vita Cizek
         email                : weetya (at) gmail.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 QGSATTRIBUTETABLEMODEL_H
#define QGSATTRIBUTETABLEMODEL_H

#include <QAbstractTableModel>
#include "qgis_sip.h"
#include <QModelIndex>
#include <QObject>
#include <QHash>
#include <QQueue>
#include <QMap>

#include "qgsconditionalstyle.h"
#include "qgsattributeeditorcontext.h"
#include "qgsvectorlayercache.h"
#include "qgis_gui.h"

class QgsMapCanvas;
class QgsMapLayerAction;
class QgsEditorWidgetFactory;
class QgsFieldFormatter;

class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel
{
    Q_OBJECT

  public:
    enum Role
    {
      FeatureIdRole = Qt::UserRole, 
      FieldIndexRole,               
      UserRole,                     
      // Insert new values here, SortRole needs to be the last one
      SortRole,                     
    };

  public:

    QgsAttributeTableModel( QgsVectorLayerCache *layerCache, QObject *parent = nullptr );

    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;

    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;

    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;

    QVariant data( const QModelIndex &index, int role ) const override;

    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;

    Qt::ItemFlags flags( const QModelIndex &index ) const override;

    void reload( const QModelIndex &index1, const QModelIndex &index2 );

    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;

    inline void resetModel() { loadLayer(); }

    int idToRow( QgsFeatureId id ) const;

    QModelIndex idToIndex( QgsFeatureId id ) const;

    QModelIndexList idToIndexList( QgsFeatureId id ) const;

    int fieldIdx( int col ) const;

    int fieldCol( int idx ) const;

    QgsFeatureId rowToId( int row ) const;

    void swapRows( QgsFeatureId a, QgsFeatureId b );

    inline QgsVectorLayer *layer() const { return mLayerCache ? mLayerCache->layer() : nullptr; }

    inline QgsVectorLayerCache *layerCache() const { return mLayerCache; }

    void executeAction( QUuid action, const QModelIndex &idx ) const;

    void executeMapLayerAction( QgsMapLayerAction *action, const QModelIndex &idx ) const;

    QgsFeature feature( const QModelIndex &idx ) const;

    void prefetchColumnData( int column );

    void prefetchSortData( const QString &expression, unsigned long cacheIndex = 0 );

    QString sortCacheExpression( unsigned long cacheIndex = 0 ) const;

    void setRequest( const QgsFeatureRequest &request );

    // TODO QGIS 4: return copy instead of reference

    const QgsFeatureRequest &request() const;

    void setEditorContext( const QgsAttributeEditorContext &context ) { mEditorContext = context; }

    const QgsAttributeEditorContext &editorContext() const { return mEditorContext; }

    int extraColumns() const;

    void setExtraColumns( int extraColumns );

  public slots:

    virtual void loadLayer();

    void fieldConditionalStyleChanged( const QString &fieldName );

  signals:

    void modelChanged();

    void progress( int i, bool &cancel ) SIP_SKIP;
    void finished();

  private slots:

    virtual void updatedFields();

    virtual void editCommandEnded();

    virtual void attributeDeleted( int idx );

    virtual void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value );

    virtual void featuresDeleted( const QgsFeatureIds &fids );

    virtual void featureAdded( QgsFeatureId fid, bool resettingModel = false );

    virtual void layerDeleted();

    virtual void fieldFormatterRemoved( QgsFieldFormatter *fieldFormatter );

  private:
    QgsVectorLayerCache *mLayerCache = nullptr;
    int mFieldCount = 0;

    mutable QgsFeature mFeat;

    QgsAttributeList mAttributes;
    QVector<QgsEditorWidgetFactory *> mWidgetFactories;
    QVector<QgsFieldFormatter *> mFieldFormatters;
    QVector<QVariant> mAttributeWidgetCaches;
    QVector<QVariantMap> mWidgetConfigs;

    QHash<QgsFeatureId, int> mIdRowMap;
    QHash<int, QgsFeatureId> mRowIdMap;
    mutable QHash<int, QList<QgsConditionalStyle> > mRowStylesMap;

    mutable QgsExpressionContext mExpressionContext;

    virtual void loadAttributes();

    virtual bool loadFeatureAtId( QgsFeatureId fid ) const;

    bool fieldIsEditable( const QgsVectorLayer &layer, int fieldIndex, QgsFeatureId fid ) const;

    QgsFeatureRequest mFeatureRequest;

    struct SortCache
    {
      int sortFieldIndex;
      QgsExpression sortCacheExpression;
      QgsAttributeList sortCacheAttributes;
      QHash<QgsFeatureId, QVariant> sortCache;
    };

    std::vector<SortCache> mSortCaches;

    QgsAttributeEditorContext mEditorContext;

    int mExtraColumns = 0;

    bool mBulkEditCommandRunning = false;

    void bulkEditCommandStarted();

    void bulkEditCommandEnded();

    QMap<QPair<QgsFeatureId, int>, QVariant> mAttributeValueChanges;

    friend class TestQgsAttributeTable;

};


#endif