QGIS API Documentation  3.21.0-Master (909859188c)
qgsattributetablefiltermodel.h
Go to the documentation of this file.
1 /***************************************************************************
2  QgsAttributeTableFilterModel.h - Filter Model for attribute table
3  -------------------
4  date : Feb 2009
5  copyright : (C) 2009 by Vita Cizek
6  email : weetya (at) gmail.com
7 
8  ***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 
17 #ifndef QGSATTRIBUTETABLEFILTERMODEL_H
18 #define QGSATTRIBUTETABLEFILTERMODEL_H
19 
20 #include <QSortFilterProxyModel>
21 #include <QModelIndex>
22 #include <QTimer>
23 
24 #include "qgsattributetablemodel.h"
25 #include "qgsfeaturemodel.h"
26 #include "qgis_gui.h"
27 
29 class QgsMapCanvas;
30 class QItemSelectionModel;
31 
36 class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, public QgsFeatureModel
37 {
38  Q_OBJECT
39 
40  public:
41 
46  {
51  ShowEdited
52  };
53  Q_ENUM( FilterMode )
54 
55 
59  {
61  ColumnTypeActionButton
62  };
63  Q_ENUM( ColumnType )
64 
65 
70  enum Role
71  {
73  };
74 
75 
83  QgsAttributeTableFilterModel( QgsMapCanvas *canvas, QgsAttributeTableModel *sourceModel, QObject *parent SIP_TRANSFERTHIS = nullptr );
84 
85 #ifdef __clang__
86 #pragma clang diagnostic push
87 #pragma clang diagnostic ignored "-Woverloaded-virtual"
88 #endif
89 
97  void setSourceModel( QgsAttributeTableModel *sourceModel );
98 
99 #ifdef __clang__
100 #pragma clang diagnostic pop
101 #endif
102 
109  void setSelectedOnTop( bool selectedOnTop );
110 
116  bool selectedOnTop();
117 
124  virtual void setFilteredFeatures( const QgsFeatureIds &ids );
125 
131  QgsFeatureIds filteredFeatures();
132 
138  void setFilterMode( FilterMode filterMode );
139 
143  void disconnectFilterModeConnections();
144 
148  void connectFilterModeConnections( FilterMode filterMode );
149 
153  FilterMode filterMode() { return mFilterMode; }
154 
160  inline QgsVectorLayer *layer() const { return masterModel()->layer(); }
161 
167  inline QgsVectorLayerCache *layerCache() const { return masterModel()->layerCache(); }
168 
174  inline QgsAttributeTableModel *masterModel() const { return mTableModel; }
175 
183  QgsFeatureId rowToId( const QModelIndex &row );
184 
185  QModelIndex fidToIndex( QgsFeatureId fid ) override;
186 
187  QModelIndexList fidToIndexList( QgsFeatureId fid );
188 
189  inline QModelIndex mapToMaster( const QModelIndex &proxyIndex ) const { return mapToSource( proxyIndex ); }
190 
191  inline QModelIndex mapFromMaster( const QModelIndex &sourceIndex ) const { return mapFromSource( sourceIndex ); }
192 
193  QModelIndex mapToSource( const QModelIndex &proxyIndex ) const override;
194 
195  QModelIndex mapFromSource( const QModelIndex &sourceIndex ) const override;
196 
197  Qt::ItemFlags flags( const QModelIndex &index ) const override;
198 
206  void sort( int column, Qt::SortOrder order = Qt::AscendingOrder ) override;
207 
215  void sort( const QString &expression, Qt::SortOrder order = Qt::AscendingOrder );
216 
220  QString sortExpression() const;
221 
223  QgsMapCanvas *mapCanvas() const { return mCanvas; }
224 
225  QVariant data( const QModelIndex &index, int role ) const override;
226 
227  QVariant headerData( int section, Qt::Orientation orientation, int role ) const override;
228 
233  int actionColumnIndex() const;
234 
235  int columnCount( const QModelIndex &parent ) const override;
236 
242  void setAttributeTableConfig( const QgsAttributeTableConfig &config );
243 
250  void setFilterExpression( const QgsExpression &expression, const QgsExpressionContext &context );
251 
252  signals:
253 
259  void sortColumnChanged( int column, Qt::SortOrder order );
260 
265 
270 
275  void filterError( const QString &errorMessage );
276 
277  protected:
278 
285  bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
286 
291  void generateListOfVisibleFeatures();
292 
297  bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
298 
299  public slots:
300 
307  Q_DECL_DEPRECATED void extentsChanged();
308 
315  void filterFeatures();
316 
317  private slots:
318  void selectionChanged();
319  void onColumnsChanged();
320  void reloadVisible();
321  void onAttributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value );
322  void onGeometryChanged();
323 
324  private:
325  QgsFeatureIds mFilteredFeatures;
326  QgsMapCanvas *mCanvas = nullptr;
327  FilterMode mFilterMode = FilterMode::ShowAll;
328  bool mSelectedOnTop = false;
329  QgsAttributeTableModel *mTableModel = nullptr;
330 
331  QgsAttributeTableConfig mConfig;
332  QVector<int> mColumnMapping;
333  QgsExpression mFilterExpression;
334  QgsExpressionContext mFilterExpressionContext;
335 
336  int mapColumnToSource( int column ) const;
337  int mapColumnFromSource( int column ) const;
338 
339  QTimer mReloadVisibleTimer;
340  QTimer mFilterFeaturesTimer;
341  void startTimedReloadVisible();
342  void startTimedFilterFeatures();
343 };
344 
345 #endif
This is a container for configuration of the attribute table.
FilterMode filterMode()
The current filterModel.
Role
The additional roles defined by this filter model.
QgsVectorLayer * layer() const
Returns the layer this filter acts on.
QgsMapCanvas * mapCanvas() const
Returns the map canvas.
FilterMode
The filter mode defines how the rows should be filtered.
@ ShowFilteredList
Show only features whose ids are on the filter list. {.
@ ShowVisible
Show only visible features (depends on the map canvas)
@ ShowSelected
Show only selected features.
void filterError(const QString &errorMessage)
Emitted when an error occurred while filtering features.
QModelIndex mapFromMaster(const QModelIndex &sourceIndex) const
QModelIndex mapToMaster(const QModelIndex &proxyIndex) const
void featuresFiltered()
Emitted when the filtering of the features has been done.
void visibleReloaded()
Emitted when the the visible features on extend are reloaded (the list is created)
@ ColumnTypeField
This column shows a field.
QgsVectorLayerCache * layerCache() const
Returns the layerCache this filter acts on.
QgsAttributeTableModel * masterModel() const
Returns the table model this filter is using.
void sortColumnChanged(int column, Qt::SortOrder order)
Emitted whenever the sort column is changed.
A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a Q...
@ UserRole
Start further roles starting from this role.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Class for parsing and evaluation of expressions (formerly called "search strings").
virtual QModelIndex fidToIndex(QgsFeatureId fid)=0
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:87
This class caches features of a given QgsVectorLayer.
Represents a vector layer which manages a vector based data sets.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:37
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28