qgsattributetablefiltermodel.h

Go to the documentation of this file.

/***************************************************************************
  QgsAttributeTableFilterModel.h - Filter Model 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 QGSATTRIBUTETABLEFILTERMODEL_H
#define QGSATTRIBUTETABLEFILTERMODEL_H

#include <QSortFilterProxyModel>
#include <QModelIndex>

#include "qgsattributetablemodel.h"
#include "qgsfeaturemodel.h"
#include "qgis_gui.h"

class QgsVectorLayerCache;
class QgsMapCanvas;
class QItemSelectionModel;

class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, public QgsFeatureModel
{
    Q_OBJECT

  public:

    enum FilterMode
    {
      ShowAll,          
      ShowSelected,     
      ShowVisible,      
      ShowFilteredList, 
      ShowEdited        
    };
    Q_ENUM( FilterMode )

    
    enum ColumnType
    {
      ColumnTypeField,       
      ColumnTypeActionButton 
    };
    Q_ENUM( ColumnType )

    
    enum Role
    {
      TypeRole = QgsAttributeTableModel::UserRole 
    };


    QgsAttributeTableFilterModel( QgsMapCanvas *canvas, QgsAttributeTableModel *sourceModel, QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setSourceModel( QgsAttributeTableModel *sourceModel );

    void setSelectedOnTop( bool selectedOnTop );

    bool selectedOnTop();

    virtual void setFilteredFeatures( const QgsFeatureIds &ids );

    QgsFeatureIds filteredFeatures();

    void setFilterMode( FilterMode filterMode );

    FilterMode filterMode() { return mFilterMode; }

    inline QgsVectorLayer *layer() const { return masterModel()->layer(); }

    inline QgsVectorLayerCache *layerCache() const { return masterModel()->layerCache(); }

    inline QgsAttributeTableModel *masterModel() const { return mTableModel; }

    QgsFeatureId rowToId( const QModelIndex &row );

    QModelIndex fidToIndex( QgsFeatureId fid ) override;

    QModelIndexList fidToIndexList( QgsFeatureId fid );

    inline QModelIndex mapToMaster( const QModelIndex &proxyIndex ) const { return mapToSource( proxyIndex ); }

    inline QModelIndex mapFromMaster( const QModelIndex &sourceIndex ) const { return mapFromSource( sourceIndex ); }

    QModelIndex mapToSource( const QModelIndex &proxyIndex ) const override;

    QModelIndex mapFromSource( const QModelIndex &sourceIndex ) const override;

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

    void sort( int column, Qt::SortOrder order = Qt::AscendingOrder ) override;

    void sort( const QString &expression, Qt::SortOrder order = Qt::AscendingOrder );

    QString sortExpression() const;

    QgsMapCanvas *mapCanvas() const { return mCanvas; }

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

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

    int actionColumnIndex() const;

    int columnCount( const QModelIndex &parent ) const override;

    void setAttributeTableConfig( const QgsAttributeTableConfig &config );

  signals:

    void sortColumnChanged( int column, Qt::SortOrder order );

  protected:

    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;

    void generateListOfVisibleFeatures();

    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;

  public slots:

    void extentsChanged();

  private slots:
    void selectionChanged();
    void onColumnsChanged();

  private:
    QgsFeatureIds mFilteredFeatures;
    QgsMapCanvas *mCanvas = nullptr;
    FilterMode mFilterMode = FilterMode::ShowAll;
    bool mSelectedOnTop = false;
    QgsAttributeTableModel *mTableModel = nullptr;

    QgsAttributeTableConfig mConfig;
    QVector<int> mColumnMapping;
    int mapColumnToSource( int column ) const;
    int mapColumnFromSource( int column ) const;

};

#endif