QGIS API Documentation  3.23.0-Master (22c16f2067)
qgsfeaturelistmodel.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsfeaturelistmodel.h
3  ---------------------
4  begin : February 2013
5  copyright : (C) 2013 by Matthias Kuhn
6  email : matthias at opengis dot ch
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 #ifndef QGSATTRIBUTEEDITORMODEL_H
16 #define QGSATTRIBUTEEDITORMODEL_H
17 
18 #include "qgsexpression.h"
19 
20 #include <QSortFilterProxyModel>
21 #include <QVariant>
22 #include <QItemSelectionModel>
23 #include <QPointer>
24 
25 #include "qgsfeaturemodel.h"
26 #include "qgsfeature.h" // QgsFeatureId
27 #include "qgsexpressioncontext.h"
28 #include "qgsconditionalstyle.h"
29 #include "qgis_gui.h"
30 
34 
39 class GUI_EXPORT QgsFeatureListModel : public QSortFilterProxyModel, public QgsFeatureModel
40 {
41  Q_OBJECT
42 
43  public:
44  struct FeatureInfo
45  {
46  public:
47 
51  FeatureInfo() = default;
52 
54  bool isNew = false;
55 
57  bool isEdited = false;
58  };
59 
60  enum Role
61  {
62  FeatureInfoRole = 0x1000, // Make sure no collisions with roles on QgsAttributeTableModel
63  FeatureRole
64  };
65 
66  public:
67 
69  explicit QgsFeatureListModel( QgsAttributeTableFilterModel *sourceModel, QObject *parent SIP_TRANSFERTHIS = nullptr );
70 
71 #ifdef __clang__
72 #pragma clang diagnostic push
73 #pragma clang diagnostic ignored "-Woverloaded-virtual"
74 #endif
75  virtual void setSourceModel( QgsAttributeTableFilterModel *sourceModel );
76 #ifdef __clang__
77 #pragma clang diagnostic pop
78 #endif
79 
83  QgsVectorLayerCache *layerCache();
84 
85  QVariant data( const QModelIndex &index, int role ) const override;
86  Qt::ItemFlags flags( const QModelIndex &index ) const override;
87 
94  void setInjectNull( bool injectNull );
95 
101  bool injectNull();
102 
103  QgsAttributeTableModel *masterModel();
104 
111  bool setDisplayExpression( const QString &expression );
112 
117  QString parserErrorString();
118 
119  QString displayExpression() const;
120  bool featureByIndex( const QModelIndex &index, QgsFeature &feat );
121 
126  QgsFeatureId idxToFid( const QModelIndex &index ) const;
127 
132  QModelIndex fidToIdx( QgsFeatureId fid ) const;
133 
134  QModelIndex mapToSource( const QModelIndex &proxyIndex ) const override;
135  QModelIndex mapFromSource( const QModelIndex &sourceIndex ) const override;
136 
137  virtual QModelIndex mapToMaster( const QModelIndex &proxyIndex ) const;
138  virtual QModelIndex mapFromMaster( const QModelIndex &sourceIndex ) const;
139 
140  virtual QItemSelection mapSelectionFromMaster( const QItemSelection &selection ) const;
141  virtual QItemSelection mapSelectionToMaster( const QItemSelection &selection ) const;
142 
143  QModelIndex parent( const QModelIndex &child ) const override;
144  int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
145  int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
146 
147  QModelIndex fidToIndex( QgsFeatureId fid ) override;
148  QModelIndexList fidToIndexList( QgsFeatureId fid );
149 
155  bool sortByDisplayExpression() const;
156 
165  void setSortByDisplayExpression( bool sortByDisplayExpression, Qt::SortOrder order = Qt::AscendingOrder );
166 
167  public slots:
168 
174  Q_DECL_DEPRECATED void onBeginRemoveRows( const QModelIndex &parent, int first, int last );
175 
181  Q_DECL_DEPRECATED void onEndRemoveRows( const QModelIndex &parent, int first, int last );
182 
188  Q_DECL_DEPRECATED void onBeginInsertRows( const QModelIndex &parent, int first, int last );
189 
195  Q_DECL_DEPRECATED void onEndInsertRows( const QModelIndex &parent, int first, int last );
196 
197  private slots:
198 
199  void conditionalStylesChanged();
200 
201  private:
202  mutable QgsExpression mDisplayExpression;
203  QgsAttributeTableFilterModel *mFilterModel = nullptr;
204  QString mParserErrorString;
205  bool mInjectNull = false;
206  mutable QgsExpressionContext mExpressionContext;
207  mutable QMap< QgsFeatureId, QList<QgsConditionalStyle> > mRowStylesMap;
208  bool mSortByDisplayExpression = false;
209  QPointer< QgsVectorLayer > mSourceLayer;
210 };
211 
213 
214 #endif // QGSATTRIBUTEEDITORMODEL_H
A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a Q...
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
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
This class caches features of a given QgsVectorLayer.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28
Q_DECLARE_METATYPE(QgsMeshTimeSettings)
FeatureInfo()=default
Constructor for FeatureInfo.