QGIS API Documentation  3.17.0-Master (df2c9ff931)
Classes | Public Types | Public Slots | Public Member Functions | List of all members
QgsFeatureListModel Class Reference

#include <qgsfeaturelistmodel.h>

Inheritance diagram for QgsFeatureListModel:
Inheritance graph
[legend]

Classes

struct  FeatureInfo
 

Public Types

enum  Role { FeatureInfoRole = 0x1000, FeatureRole }
 

Public Slots

Q_DECL_DEPRECATED void onBeginInsertRows (const QModelIndex &parent, int first, int last)
 Does nothing except for calling beginInsertRows() More...
 
Q_DECL_DEPRECATED void onBeginRemoveRows (const QModelIndex &parent, int first, int last)
 Does nothing except for calling beginRemoveRows() More...
 
Q_DECL_DEPRECATED void onEndInsertRows (const QModelIndex &parent, int first, int last)
 Does nothing except for calling endInsertRows() More...
 
Q_DECL_DEPRECATED void onEndRemoveRows (const QModelIndex &parent, int first, int last)
 Does nothing except for calling endRemoveRows() More...
 

Public Member Functions

 QgsFeatureListModel (QgsAttributeTableFilterModel *sourceModel, QObject *parent=nullptr)
 Constructor for QgsFeatureListModel. More...
 
int columnCount (const QModelIndex &parent=QModelIndex()) const override
 
QVariant data (const QModelIndex &index, int role) const override
 
QString displayExpression () const
 
bool featureByIndex (const QModelIndex &index, QgsFeature &feat)
 
QModelIndex fidToIdx (QgsFeatureId fid) const
 Returns the model index corresponding to a feature ID. More...
 
QModelIndex fidToIndex (QgsFeatureId fid) override
 
QModelIndexList fidToIndexList (QgsFeatureId fid)
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 
QgsFeatureId idxToFid (const QModelIndex &index) const
 Returns the feature ID corresponding to an index from the model. More...
 
bool injectNull ()
 Returns the current state of null value injection. More...
 
QgsVectorLayerCachelayerCache ()
 Returns the vector layer cache which is being used to populate the model. More...
 
virtual QModelIndex mapFromMaster (const QModelIndex &sourceIndex) const
 
QModelIndex mapFromSource (const QModelIndex &sourceIndex) const override
 
virtual QItemSelection mapSelectionFromMaster (const QItemSelection &selection) const
 
virtual QItemSelection mapSelectionToMaster (const QItemSelection &selection) const
 
virtual QModelIndex mapToMaster (const QModelIndex &proxyIndex) const
 
QModelIndex mapToSource (const QModelIndex &proxyIndex) const override
 
QgsAttributeTableModelmasterModel ()
 
QModelIndex parent (const QModelIndex &child) const override
 
QString parserErrorString ()
 Returns a detailed message about errors while parsing a QgsExpression. More...
 
int rowCount (const QModelIndex &parent=QModelIndex()) const override
 
bool setDisplayExpression (const QString &expression)
 
void setInjectNull (bool injectNull)
 If true is specified, a NULL value will be injected. More...
 
void setSortByDisplayExpression (bool sortByDisplayExpression, Qt::SortOrder order=Qt::AscendingOrder)
 Sort this model by its display expression. More...
 
virtual void setSourceModel (QgsAttributeTableFilterModel *sourceModel)
 
bool sortByDisplayExpression () const
 Sort this model by its display expression. More...
 
- Public Member Functions inherited from QgsFeatureModel
virtual ~QgsFeatureModel ()=default
 

Detailed Description

Definition at line 38 of file qgsfeaturelistmodel.h.

Member Enumeration Documentation

◆ Role

Enumerator
FeatureInfoRole 
FeatureRole 

Definition at line 59 of file qgsfeaturelistmodel.h.

Constructor & Destructor Documentation

◆ QgsFeatureListModel()

QgsFeatureListModel::QgsFeatureListModel ( QgsAttributeTableFilterModel sourceModel,
QObject *  parent = nullptr 
)
explicit

Constructor for QgsFeatureListModel.

Definition at line 26 of file qgsfeaturelistmodel.cpp.

Member Function Documentation

◆ columnCount()

int QgsFeatureListModel::columnCount ( const QModelIndex &  parent = QModelIndex()) const
override

Definition at line 407 of file qgsfeaturelistmodel.cpp.

◆ data()

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

Definition at line 60 of file qgsfeaturelistmodel.cpp.

◆ displayExpression()

QString QgsFeatureListModel::displayExpression ( ) const

Definition at line 250 of file qgsfeaturelistmodel.cpp.

◆ featureByIndex()

bool QgsFeatureListModel::featureByIndex ( const QModelIndex &  index,
QgsFeature feat 
)

Definition at line 255 of file qgsfeaturelistmodel.cpp.

◆ fidToIdx()

QModelIndex QgsFeatureListModel::fidToIdx ( QgsFeatureId  fid) const

Returns the model index corresponding to a feature ID.

See also
idxToFid()

Definition at line 55 of file qgsfeaturelistmodel.cpp.

◆ fidToIndex()

QModelIndex QgsFeatureListModel::fidToIndex ( QgsFeatureId  fid)
overridevirtual

Implements QgsFeatureModel.

Definition at line 422 of file qgsfeaturelistmodel.cpp.

◆ fidToIndexList()

QModelIndexList QgsFeatureListModel::fidToIndexList ( QgsFeatureId  fid)

Definition at line 427 of file qgsfeaturelistmodel.cpp.

◆ flags()

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

Definition at line 187 of file qgsfeaturelistmodel.cpp.

◆ idxToFid()

QgsFeatureId QgsFeatureListModel::idxToFid ( const QModelIndex &  index) const

Returns the feature ID corresponding to an index from the model.

See also
fidToIdx()

Definition at line 50 of file qgsfeaturelistmodel.cpp.

◆ injectNull()

bool QgsFeatureListModel::injectNull ( )

Returns the current state of null value injection.

Returns
If a NULL value is added
Since
QGIS 2.9

Definition at line 212 of file qgsfeaturelistmodel.cpp.

◆ layerCache()

QgsVectorLayerCache * QgsFeatureListModel::layerCache ( )

Returns the vector layer cache which is being used to populate the model.

Definition at line 45 of file qgsfeaturelistmodel.cpp.

◆ mapFromMaster()

QModelIndex QgsFeatureListModel::mapFromMaster ( const QModelIndex &  sourceIndex) const
virtual

Definition at line 330 of file qgsfeaturelistmodel.cpp.

◆ mapFromSource()

QModelIndex QgsFeatureListModel::mapFromSource ( const QModelIndex &  sourceIndex) const
override

Definition at line 384 of file qgsfeaturelistmodel.cpp.

◆ mapSelectionFromMaster()

QItemSelection QgsFeatureListModel::mapSelectionFromMaster ( const QItemSelection &  selection) const
virtual

Definition at line 351 of file qgsfeaturelistmodel.cpp.

◆ mapSelectionToMaster()

QItemSelection QgsFeatureListModel::mapSelectionToMaster ( const QItemSelection &  selection) const
virtual

Definition at line 356 of file qgsfeaturelistmodel.cpp.

◆ mapToMaster()

QModelIndex QgsFeatureListModel::mapToMaster ( const QModelIndex &  proxyIndex) const
virtual

Definition at line 310 of file qgsfeaturelistmodel.cpp.

◆ mapToSource()

QModelIndex QgsFeatureListModel::mapToSource ( const QModelIndex &  proxyIndex) const
override

Definition at line 363 of file qgsfeaturelistmodel.cpp.

◆ masterModel()

QgsAttributeTableModel * QgsFeatureListModel::masterModel ( )

Definition at line 217 of file qgsfeaturelistmodel.cpp.

◆ onBeginInsertRows

void QgsFeatureListModel::onBeginInsertRows ( const QModelIndex &  parent,
int  first,
int  last 
)
slot

Does nothing except for calling beginInsertRows()

Deprecated:
use beginInsertRows() instead

Definition at line 273 of file qgsfeaturelistmodel.cpp.

◆ onBeginRemoveRows

void QgsFeatureListModel::onBeginRemoveRows ( const QModelIndex &  parent,
int  first,
int  last 
)
slot

Does nothing except for calling beginRemoveRows()

Deprecated:
Use beginRemoveRows() instead

Definition at line 260 of file qgsfeaturelistmodel.cpp.

◆ onEndInsertRows

void QgsFeatureListModel::onEndInsertRows ( const QModelIndex &  parent,
int  first,
int  last 
)
slot

Does nothing except for calling endInsertRows()

Deprecated:
use endInsertRows() instead

Definition at line 278 of file qgsfeaturelistmodel.cpp.

◆ onEndRemoveRows

void QgsFeatureListModel::onEndRemoveRows ( const QModelIndex &  parent,
int  first,
int  last 
)
slot

Does nothing except for calling endRemoveRows()

Deprecated:
Use endRemoveRows() instead

Definition at line 265 of file qgsfeaturelistmodel.cpp.

◆ parent()

QModelIndex QgsFeatureListModel::parent ( const QModelIndex &  child) const
override

Definition at line 401 of file qgsfeaturelistmodel.cpp.

◆ parserErrorString()

QString QgsFeatureListModel::parserErrorString ( )

Returns a detailed message about errors while parsing a QgsExpression.

Returns
A message containing information about the parser error.

Definition at line 245 of file qgsfeaturelistmodel.cpp.

◆ rowCount()

int QgsFeatureListModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const
override

Definition at line 413 of file qgsfeaturelistmodel.cpp.

◆ setDisplayExpression()

bool QgsFeatureListModel::setDisplayExpression ( const QString &  expression)
Parameters
expressionA QgsExpression compatible string.
Returns
true if the expression could be set, false if there was a parse error. If it fails, the old expression will still be applied. Call parserErrorString() for a meaningful error message.

Definition at line 222 of file qgsfeaturelistmodel.cpp.

◆ setInjectNull()

void QgsFeatureListModel::setInjectNull ( bool  injectNull)

If true is specified, a NULL value will be injected.

Parameters
injectNullstate of null value injection
Note
If set to true, the sort by display expression cannot be used
Since
QGIS 2.9

Definition at line 199 of file qgsfeaturelistmodel.cpp.

◆ setSortByDisplayExpression()

void QgsFeatureListModel::setSortByDisplayExpression ( bool  sortByDisplayExpression,
Qt::SortOrder  order = Qt::AscendingOrder 
)

Sort this model by its display expression.

Note
Not compatible with injectNull, if sorting by display expression is enabled, injectNull will automatically turned off.
Since
QGIS 3.2

Definition at line 297 of file qgsfeaturelistmodel.cpp.

◆ setSourceModel()

void QgsFeatureListModel::setSourceModel ( QgsAttributeTableFilterModel sourceModel)
virtual

Definition at line 32 of file qgsfeaturelistmodel.cpp.

◆ sortByDisplayExpression()

bool QgsFeatureListModel::sortByDisplayExpression ( ) const

Sort this model by its display expression.

Since
QGIS 3.2

Definition at line 292 of file qgsfeaturelistmodel.cpp.


The documentation for this class was generated from the following files: