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 "qgis.h"
#include "qgis_gui.h"
#include "qgsattributetablemodel.h"
#include "qgsfeaturemodel.h"
 
#include <QModelIndex>
#include <QSortFilterProxyModel>
#include <QTimer>
 
class QgsVectorLayerCache;
class QgsMapCanvas;
class QItemSelectionModel;

class GUI_EXPORT QgsAttributeTableFilterModel : public QSortFilterProxyModel, public QgsFeatureModel
{
    Q_OBJECT
 
  public:
    enum ColumnType
    {
      ColumnTypeField,       
      ColumnTypeActionButton 
    };
    Q_ENUM( ColumnType )
 
    // *INDENT-OFF*
 
    
    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAttributeTableFilterModel, Role ) : int
    {
      Type SIP_MONKEYPATCH_COMPAT_NAME( TypeRole ) = static_cast<int>( QgsAttributeTableModel::CustomRole::User ) 
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    QgsAttributeTableFilterModel( QgsMapCanvas *canvas, QgsAttributeTableModel *sourceModel, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Woverloaded-virtual"
#endif

    void setSourceModel( QgsAttributeTableModel *sourceModel );
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif

    void setSelectedOnTop( bool selectedOnTop );

    bool selectedOnTop();

    virtual void setFilteredFeatures( const QgsFeatureIds &ids );

    QgsFeatureIds filteredFeatures() const;

    void setFilterMode( Qgis::AttributeTableFilterMode filterMode );

    void disconnectFilterModeConnections();

    void connectFilterModeConnections( Qgis::AttributeTableFilterMode filterMode );

    Qgis::AttributeTableFilterMode 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 ) const;
 
    QModelIndex fidToIndex( QgsFeatureId fid ) override;
 
    QModelIndexList fidToIndexList( QgsFeatureId fid );
 
    QModelIndex mapToMaster( const QModelIndex &proxyIndex ) const;
 
    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, bool force SIP_PYARGREMOVE = false );

    void setFilterExpression( const QgsExpression &expression, const QgsExpressionContext &context );

    QString filterExpression() const { return mFilterExpression; };
 
  signals:

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

    void featuresFiltered();

    void visibleReloaded();

    void filterError( const QString &errorMessage );
 
  protected:
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;

    void generateListOfVisibleFeatures();

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

    Q_DECL_DEPRECATED void extentsChanged();

    void filterFeatures();
 
  private slots:
    void selectionChanged();
    void onColumnsChanged();
    void reloadVisible();
    void onAttributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value );
    void onGeometryChanged();
 
  private:
    QgsFeatureIds mFilteredFeatures;
    QgsMapCanvas *mCanvas = nullptr;
    Qgis::AttributeTableFilterMode mFilterMode = Qgis::AttributeTableFilterMode::ShowAll;
    bool mSelectedOnTop = false;
    QgsAttributeTableModel *mTableModel = nullptr;
 
    QgsAttributeTableConfig mConfig;
    QVector<int> mColumnMapping;
    QgsExpression mFilterExpression;
    QgsExpressionContext mFilterExpressionContext;
 
    int mapColumnToSource( int column ) const;
    int mapColumnFromSource( int column ) const;
 
    QTimer mReloadVisibleTimer;
    QTimer mFilterFeaturesTimer;
    void startTimedReloadVisible();
    void startTimedFilterFeatures();
};
 
#endif