QGIS API Documentation  2.99.0-Master (cd0ba91)
qgsattributetablemodel.h
Go to the documentation of this file.
1 /***************************************************************************
2  QgsAttributeTableModel.h - Models for attribute table
3  -------------------
4  date : Feb 2009
5  copyright : 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 QGSATTRIBUTETABLEMODEL_H
18 #define QGSATTRIBUTETABLEMODEL_H
19 
20 #include <QAbstractTableModel>
21 #include "qgis_sip.h"
22 #include <QModelIndex>
23 #include <QObject>
24 #include <QHash>
25 #include <QQueue>
26 #include <QMap>
27 
28 #include "qgsvectorlayer.h" // QgsAttributeList
29 #include "qgsconditionalstyle.h"
31 #include "qgsvectorlayercache.h"
32 #include "qgis_gui.h"
33 
34 class QgsMapCanvas;
35 class QgsMapLayerAction;
37 class QgsFieldFormatter;
38 
50 class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel
51 {
52  Q_OBJECT
53 
54  public:
55  enum Role
56  {
57  SortRole = Qt::UserRole + 1,
60  UserRole
61  };
62 
63  public:
64 
70  QgsAttributeTableModel( QgsVectorLayerCache *layerCache, QObject *parent = nullptr );
71 
76  virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
77 
82  int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
83 
90  QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
91 
97  virtual QVariant data( const QModelIndex &index, int role ) const override;
98 
105  virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
106 
111  Qt::ItemFlags flags( const QModelIndex &index ) const override;
112 
118  void reload( const QModelIndex &index1, const QModelIndex &index2 );
119 
123  bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
124 
130  inline void resetModel() { loadLayer(); }
131 
136  int idToRow( QgsFeatureId id ) const;
137 
138  QModelIndex idToIndex( QgsFeatureId id ) const;
139 
140  QModelIndexList idToIndexList( QgsFeatureId id ) const;
141 
145  int fieldIdx( int col ) const;
146 
150  int fieldCol( int idx ) const;
151 
156  QgsFeatureId rowToId( int row ) const;
157 
163  void swapRows( QgsFeatureId a, QgsFeatureId b );
164 
168  inline QgsVectorLayer *layer() const { return mLayerCache ? mLayerCache->layer() : nullptr; }
169 
173  inline QgsVectorLayerCache *layerCache() const { return mLayerCache; }
174 
178  void executeAction( const QUuid &action, const QModelIndex &idx ) const;
179 
183  void executeMapLayerAction( QgsMapLayerAction *action, const QModelIndex &idx ) const;
184 
189  QgsFeature feature( const QModelIndex &idx ) const;
190 
198  void prefetchColumnData( int column );
199 
206  void prefetchSortData( const QString &expression );
207 
211  QString sortCacheExpression() const;
212 
220  void setRequest( const QgsFeatureRequest &request );
221 
225  // TODO QGIS 3: return copy instead of reference
226  const QgsFeatureRequest &request() const;
227 
234  void setEditorContext( const QgsAttributeEditorContext &context ) { mEditorContext = context; }
235 
242  const QgsAttributeEditorContext &editorContext() const { return mEditorContext; }
243 
248  int extraColumns() const;
249 
254  void setExtraColumns( int extraColumns );
255 
256  public slots:
257 
262  virtual void loadLayer();
263 
269  void fieldConditionalStyleChanged( const QString &fieldName );
270 
271  signals:
272 
276  void modelChanged();
277 
279  void progress( int i, bool &cancel ) SIP_SKIP;
280  void finished();
281 
282  private slots:
283 
287  virtual void updatedFields();
288 
294  virtual void editCommandEnded();
295 
299  virtual void attributeDeleted( int idx );
300 
307  virtual void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value );
308 
313  virtual void featuresDeleted( const QgsFeatureIds &fids );
314 
321  virtual void featureAdded( QgsFeatureId fid, bool resettingModel = false );
322 
326  virtual void layerDeleted();
327 
328  virtual void fieldFormatterRemoved( QgsFieldFormatter *fieldFormatter );
329 
330  private:
331  QgsVectorLayerCache *mLayerCache = nullptr;
332  int mFieldCount;
333 
334  mutable QgsFeature mFeat;
335 
336  QgsAttributeList mAttributes;
337  QVector<QgsEditorWidgetFactory *> mWidgetFactories;
338  QVector<QgsFieldFormatter *> mFieldFormatters;
339  QVector<QVariant> mAttributeWidgetCaches;
340  QVector<QVariantMap> mWidgetConfigs;
341 
342  QHash<QgsFeatureId, int> mIdRowMap;
343  QHash<int, QgsFeatureId> mRowIdMap;
344  mutable QHash<int, QList<QgsConditionalStyle> > mRowStylesMap;
345 
346  mutable QgsExpressionContext mExpressionContext;
347 
351  virtual void loadAttributes();
352 
360  virtual bool loadFeatureAtId( QgsFeatureId fid ) const;
361 
362  bool fieldIsEditable( const QgsVectorLayer &layer, int fieldIndex, QgsFeatureId fid ) const;
363 
364  QgsFeatureRequest mFeatureRequest;
365 
367  QgsExpression mSortCacheExpression;
368  QgsAttributeList mSortCacheAttributes;
370  int mSortFieldIndex;
372  QHash<QgsFeatureId, QVariant> mSortCache;
373 
381  QRect mChangedCellBounds;
382 
383  QgsAttributeEditorContext mEditorContext;
384 
385  int mExtraColumns;
386 
387  friend class TestQgsAttributeTable;
388 
389 };
390 
391 
392 #endif
QgsVectorLayer * layer() const
Returns the layer this model uses as backend.
Get the field index of this column.
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeature.h:544
This class contains context information for attribute editor widgets.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:62
A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a Q...
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:74
void resetModel()
Resets the model.
Get the feature id of the feature in this row.
#define SIP_SKIP
Definition: qgis_sip.h:119
void setEditorContext(const QgsAttributeEditorContext &context)
Sets the context in which this table is shown.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Every attribute editor widget needs a factory, which inherits this class.
This class wraps a request for features to a vector layer (or directly its vector data provider)...
QgsVectorLayerCache * layerCache() const
Returns the layer cache this model uses as backend.
A field formatter helps to handle and display values for a field.
This class caches features of a given QgsVectorLayer.
qint64 QgsFeatureId
Definition: qgsfeature.h:37
const QgsAttributeEditorContext & editorContext() const
Returns the context in which this table is shown.
QList< int > QgsAttributeList
Definition: qgsfield.h:27
Represents a vector layer which manages a vector based data sets.
An action which can run on map layers.