#include <qgsfeaturelistmodel.h>

Inheritance diagram for QgsFeatureListModel:

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...

QgsVectorLayerCache *	layerCache ()
	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

QgsAttributeTableModel *	masterModel ()

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)
	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 39 of file qgsfeaturelistmodel.h.

Member Enumeration Documentation

enum QgsFeatureListModel::Role

Enumerator
FeatureInfoRole
FeatureRole

Definition at line 60 of file qgsfeaturelistmodel.h.

Constructor & Destructor Documentation

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

explicit

Constructor for QgsFeatureListModel.

Definition at line 25 of file qgsfeaturelistmodel.cpp.

Member Function Documentation

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

override

Definition at line 382 of file qgsfeaturelistmodel.cpp.

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

override

Definition at line 54 of file qgsfeaturelistmodel.cpp.

QString QgsFeatureListModel::displayExpression ( ) const

Definition at line 231 of file qgsfeaturelistmodel.cpp.

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

Definition at line 236 of file qgsfeaturelistmodel.cpp.

QModelIndex QgsFeatureListModel::fidToIdx ( QgsFeatureId fid ) const

Returns the model index corresponding to a feature ID.

See also: idxToFid()

Definition at line 49 of file qgsfeaturelistmodel.cpp.

QModelIndex QgsFeatureListModel::fidToIndex ( QgsFeatureId fid )

overridevirtual

Implements QgsFeatureModel.

Definition at line 397 of file qgsfeaturelistmodel.cpp.

QModelIndexList QgsFeatureListModel::fidToIndexList ( QgsFeatureId fid )

Definition at line 402 of file qgsfeaturelistmodel.cpp.

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

override

Definition at line 168 of file qgsfeaturelistmodel.cpp.

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

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

See also: fidToIdx()

Definition at line 44 of file qgsfeaturelistmodel.cpp.

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 193 of file qgsfeaturelistmodel.cpp.

QgsVectorLayerCache * QgsFeatureListModel::layerCache ( )

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

Definition at line 39 of file qgsfeaturelistmodel.cpp.

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

virtual

Definition at line 305 of file qgsfeaturelistmodel.cpp.

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

override

Definition at line 359 of file qgsfeaturelistmodel.cpp.

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

virtual

Definition at line 326 of file qgsfeaturelistmodel.cpp.

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

virtual

Definition at line 331 of file qgsfeaturelistmodel.cpp.

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

virtual

Definition at line 285 of file qgsfeaturelistmodel.cpp.

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

override

Definition at line 338 of file qgsfeaturelistmodel.cpp.

QgsAttributeTableModel * QgsFeatureListModel::masterModel ( )

Definition at line 198 of file qgsfeaturelistmodel.cpp.

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

slot

Does nothing except for calling beginInsertRows()

Deprecated:: use beginInsertRows() instead

Definition at line 254 of file qgsfeaturelistmodel.cpp.

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

slot

Does nothing except for calling beginRemoveRows()

Deprecated:: Use beginRemoveRows() instead

Definition at line 241 of file qgsfeaturelistmodel.cpp.

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

slot

Does nothing except for calling endInsertRows()

Deprecated:: use endInsertRows() instead

Definition at line 259 of file qgsfeaturelistmodel.cpp.

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

slot

Does nothing except for calling endRemoveRows()

Deprecated:: Use endRemoveRows() instead

Definition at line 246 of file qgsfeaturelistmodel.cpp.

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

override

Definition at line 376 of file qgsfeaturelistmodel.cpp.

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 226 of file qgsfeaturelistmodel.cpp.

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

override

Definition at line 388 of file qgsfeaturelistmodel.cpp.

bool QgsFeatureListModel::setDisplayExpression ( const QString & expression )

Parameters

expression A 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 203 of file qgsfeaturelistmodel.cpp.

void QgsFeatureListModel::setInjectNull ( bool injectNull )

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

Parameters

injectNull state of null value injection

Since: QGIS 2.9

Definition at line 180 of file qgsfeaturelistmodel.cpp.

void QgsFeatureListModel::setSortByDisplayExpression ( bool sortByDisplayExpression )

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 272 of file qgsfeaturelistmodel.cpp.

void QgsFeatureListModel::setSourceModel ( QgsAttributeTableFilterModel * sourceModel )

virtual

Definition at line 31 of file qgsfeaturelistmodel.cpp.

bool QgsFeatureListModel::sortByDisplayExpression ( ) const

Sort this model by its display expression.

Since: QGIS 3.2

Definition at line 267 of file qgsfeaturelistmodel.cpp.

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

/build/qgis-3.4.15+24xenial/src/gui/attributetable/qgsfeaturelistmodel.h
/build/qgis-3.4.15+24xenial/src/gui/attributetable/qgsfeaturelistmodel.cpp

Classes

Public Types

Public Slots

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation