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 "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsattributeeditorcontext.h"
#include "qgsconditionalstyle.h"
#include "qgsmaplayeractionregistry.h"
 
#include <QAbstractTableModel>
#include <QHash>
#include <QMap>
#include <QModelIndex>
#include <QObject>
#include <QQueue>
 
class QgsMapCanvas;
class QgsEditorWidgetFactory;
class QgsFieldFormatter;
class QgsVectorLayerCache;

class GUI_EXPORT QgsAttributeTableModel : public QAbstractTableModel
{
    Q_OBJECT
 
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAttributeTableModel, Role ) : int
    {
      FeatureId SIP_MONKEYPATCH_COMPAT_NAME( FeatureIdRole ) = Qt::UserRole, 
      FieldIndex SIP_MONKEYPATCH_COMPAT_NAME( FieldIndexRole ),              
      ColumnType,                                                            
      User SIP_MONKEYPATCH_COMPAT_NAME( UserRole ),                          
      // Insert new values here, SortRole needs to be the last one
      Sort SIP_MONKEYPATCH_COMPAT_NAME( SortRole ) = User + 1000, 
    };
    Q_ENUM( CustomRole )
 
    
    enum class ColumnTypeValue SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAttributeTableFilterModel, ColumnType ) : int
    {
      Field SIP_MONKEYPATCH_COMPAT_NAME( ColumnTypeField ),              
      ActionButton SIP_MONKEYPATCH_COMPAT_NAME( ColumnTypeActionButton ) 
    };
    Q_ENUM( ColumnTypeValue )
 
    // *INDENT-ON*
 
  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 mLayer; }

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

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

    void executeMapLayerAction( QgsMapLayerAction *action, const QModelIndex &idx, const QgsMapLayerActionContext &context = QgsMapLayerActionContext() ) 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 5: return copy instead of reference

    const QgsFeatureRequest &request() const;

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

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

    Q_DECL_DEPRECATED int extraColumns() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setExtraColumns( int extraColumns ) SIP_DEPRECATED;

    bool showValidityState() const { return mShowValidityState; }

    void setShowValidityState( bool show ) { mShowValidityState = show; }
 
  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 );

    virtual void layerDeleted();
 
    virtual void fieldFormatterRemoved( QgsFieldFormatter *fieldFormatter );
 
  private:
    QgsVectorLayer *mLayer = nullptr;
    QgsVectorLayerCache *mLayerCache = nullptr;
    int mFieldCount = 0;
 
    mutable QgsFeature mFeat;
 
    QgsFields mFields;
    QgsAttributeList mAttributes;
 
    struct WidgetData
    {
        QgsFieldFormatter *fieldFormatter = nullptr;
        QVariant cache;
        QVariantMap config;
        bool loaded = false;
    };
    mutable QVector<WidgetData> mWidgetDatas;
 
    QHash<QgsFeatureId, int> mIdRowMap;
    QHash<int, QgsFeatureId> mRowIdMap;
    mutable QHash<QgsFeatureId, QList<QgsConditionalStyle>> mRowStylesMap;
    mutable QHash<QgsFeatureId, QHash<int, QgsConditionalStyle>> mConstraintStylesMap;
 
    mutable QgsExpressionContext mExpressionContext;

    const WidgetData &getWidgetData( int column ) const;

    void loadAttributes();

    virtual bool loadFeatureAtId( QgsFeatureId fid ) const;

    virtual bool loadFeatureAtId( QgsFeatureId fid, int fieldIdx ) const;
 
    QgsFeatureRequest mFeatureRequest;
 
    struct SortCache
    {
        int sortFieldIndex;
        QgsExpression sortCacheExpression;
        QgsAttributeList sortCacheAttributes;
        QHash<QgsFeatureId, QVariant> sortCache;
    };
 
    std::vector<SortCache> mSortCaches;
 
    QgsAttributeEditorContext mEditorContext;

    bool mBulkEditCommandRunning = false;

    bool mResettingModel = false;

    void bulkEditCommandStarted();

    void bulkEditCommandEnded();

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

    QList<QgsFeatureId> mInsertedRowsChanges;

    bool mIsCleaningUpAfterRollback = false;
 
    bool mShowValidityState = false;
 
    friend class TestQgsAttributeTable;
};
 
 
#endif