A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a QAbstractItemView. More...

#include <qgsattributetablemodel.h>

Collaboration diagram for QgsAttributeTableModel:

List of all members.

Public Types
enum	Role { SortRole = Qt::UserRole + 1, FeatureIdRole = Qt::UserRole + 2, FieldIndexRole = Qt::UserRole + 3 }
Signals
void	finished ()
void	modelChanged ()
	Model has been changed.
void	progress (int i, bool &cancel)
Public Member Functions
	QgsAttributeTableModel (QgsVectorLayerCache layerCache, QObject parent=0)
	Constructor.
virtual	~QgsAttributeTableModel ()
int	columnCount (const QModelIndex &parent=QModelIndex()) const
	Returns the number of columns.
virtual QVariant	data (const QModelIndex &index, int role) const
	Returns data on the given index.
void	executeAction (int action, const QModelIndex &idx) const
	Execute an action.
QgsFeature	feature (const QModelIndex &idx) const
	Return the feature attributes at given model index.
int	fieldCol (int idx) const
	get column from field index
int	fieldIdx (int col) const
	get field index from column
Qt::ItemFlags	flags (const QModelIndex &index) const
	Returns item flags for the index.
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Returns header data.
QModelIndex	idToIndex (QgsFeatureId id) const
QModelIndexList	idToIndexList (QgsFeatureId id) const
int	idToRow (QgsFeatureId id) const
	Maps feature id to table row.
QgsVectorLayer *	layer () const
	Returns the layer this model uses as backend.
QgsVectorLayerCache *	layerCache () const
	Returns the layer cache this model uses as backend.
virtual void	loadLayer ()
	Loads the layer into the model Preferably to be called, before basing any other models on this model.
void	prefetchColumnData (int column)
	Caches the entire data for one column.
void	reload (const QModelIndex &index1, const QModelIndex &index2)
	Reloads the model data between indices.
bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
	Remove rows.
void	resetModel ()
	Resets the model.
virtual int	rowCount (const QModelIndex &parent=QModelIndex()) const
	Returns the number of rows.
QgsFeatureId	rowToId (int row) const
	Maps row to feature id.
virtual bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
	Updates data on given index.
void	swapRows (QgsFeatureId a, QgsFeatureId b)
	Swaps two rows.
Protected Slots
virtual void	attributeValueChanged (QgsFeatureId fid, int idx, const QVariant &value)
	Launched when attribute value has been changed.
virtual void	featureAdded (QgsFeatureId fid, bool inOperation=true)
	Launched when a feature has been added.
virtual void	featureDeleted (QgsFeatureId fid)
	Launched when a feature has been deleted.
virtual void	layerDeleted ()
	Launched when layer has been deleted.
Protected Member Functions
virtual void	loadAttributes ()
	Gets mFieldCount, mAttributes and mValueMaps.
Protected Attributes
QgsAttributeList	mAttributes
QgsFeature	mFeat
int	mFieldCount
QHash< QgsFeatureId, int >	mIdRowMap
QgsVectorLayerCache *	mLayerCache
QHash< int, QgsFeatureId >	mRowIdMap
QMap< int, const QMap< QString, QVariant > * >	mValueMaps
Private Slots
virtual void	updatedFields ()
	Launched whenever the number of fields has changed.
Private Member Functions
virtual bool	loadFeatureAtId (QgsFeatureId fid) const
	Load feature fid into local cache (mFeat)
Private Attributes
int	mCachedField
	The currently cached column.
QgsFeatureRequest	mFeatureRequest
QHash< QgsFeatureId, QVariant >	mFieldCache
	Allows to cache one specific column (used for sorting)

Detailed Description

A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a QAbstractItemView.

Is able to generate editor widgets for its QModelIndexes as well. Is mostly referred to as "master model" within this doc and the source.

See also:: Qt Model View Programming

Definition at line 42 of file qgsattributetablemodel.h.

Member Enumeration Documentation

enum QgsAttributeTableModel::Role

Enumerator:

SortRole
FeatureIdRole
FieldIndexRole

Definition at line 47 of file qgsattributetablemodel.h.

Constructor & Destructor Documentation

QgsAttributeTableModel::QgsAttributeTableModel	(	QgsVectorLayerCache *	layerCache,
		QObject *	parent = `0`
	)

Constructor.

Parameters:

layerCache	A layer cache to use as backend
parent	The parent QObject (owner)

Definition at line 34 of file qgsattributetablemodel.cpp.

References attributeValueChanged(), featureAdded(), featureDeleted(), QgsVectorLayer::geometryType(), layer(), QgsVectorLayerCache::layer(), layerDeleted(), loadAttributes(), mFeat, mFeatureRequest, MathUtils::min(), mLayerCache, QgsFeatureRequest::NoGeometry, QGis::NoGeometry, QgsDebugMsg, QgsFeature::setFeatureId(), QgsFeatureRequest::setFlags(), and updatedFields().

QgsAttributeTableModel::~QgsAttributeTableModel ( ) [virtual]

Definition at line 60 of file qgsattributetablemodel.cpp.

References mValueMaps.

Member Function Documentation

void QgsAttributeTableModel::attributeValueChanged	(	QgsFeatureId	fid,
		int	idx,
		const QVariant &	value
	)		`[protected, virtual, slot]`

Launched when attribute value has been changed.

Parameters:

fid	feature id
idx	attribute index
value	new value

Definition at line 168 of file qgsattributetablemodel.cpp.

References fieldCol(), QgsFeature::id(), idToRow(), mCachedField, mFeat, mFieldCache, setData(), and QgsFeature::setValid().

Referenced by QgsAttributeTableModel().

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

Returns the number of columns.

Parameters:

parent parent index

Definition at line 407 of file qgsattributetablemodel.cpp.

References mFieldCount.

Referenced by featureAdded(), and idToIndexList().

QVariant QgsAttributeTableModel::data	(	const QModelIndex &	index,
		int	role
	)		const `[virtual]`

Returns data on the given index.

Parameters:

index	model index
role	data role

Definition at line 445 of file qgsattributetablemodel.cpp.

References QgsFeature::attribute(), QgsVectorLayer::Calendar, QgsField::displayString(), QgsVectorLayer::editType(), FeatureIdRole, FieldIndexRole, QgsFeature::id(), QgsFeature::isValid(), layer(), loadFeatureAtId(), mAttributes, mCachedField, mFeat, mFieldCache, mFieldCount, mValueMaps, QgsVectorLayer::pendingFields(), rowToId(), SortRole, and QgsField::type().

Referenced by feature(), and loadAttributes().

void QgsAttributeTableModel::executeAction	(	int	action,
		const QModelIndex &	idx
	)		const

Execute an action.

Definition at line 591 of file qgsattributetablemodel.cpp.

References QgsVectorLayer::actions(), QgsAttributeAction::doAction(), feature(), fieldIdx(), and layer().

Referenced by QgsAttributeTableAction::execute().

QgsFeature QgsAttributeTableModel::feature ( const QModelIndex & idx ) const

Return the feature attributes at given model index.

Returns:: feature attributes at given model index

Definition at line 597 of file qgsattributetablemodel.cpp.

References data(), QgsFeature::initAttributes(), mAttributes, rowToId(), QgsFeature::setAttribute(), and QgsFeature::setFeatureId().

Referenced by executeAction().

void QgsAttributeTableModel::featureAdded	(	QgsFeatureId	fid,
		bool	inOperation = `true`
	)		`[protected, virtual, slot]`

Launched when a feature has been added.

Parameters:

fid	feature id
inOperation	guard insertion with beginInsertRows() / endInsertRows()

Definition at line 128 of file qgsattributetablemodel.cpp.

References columnCount(), mIdRowMap, mRowIdMap, prefetchColumnData(), reload(), and rowCount().

Referenced by loadLayer(), and QgsAttributeTableModel().

void QgsAttributeTableModel::featureDeleted ( QgsFeatureId fid ) [protected, virtual, slot]

Launched when a feature has been deleted.

Parameters:

fid	feature id

Definition at line 77 of file qgsattributetablemodel.cpp.

References idToRow(), and prefetchColumnData().

Referenced by QgsAttributeTableModel().

int QgsAttributeTableModel::fieldCol ( int idx ) const

get column from field index

Definition at line 396 of file qgsattributetablemodel.cpp.

References mAttributes.

Referenced by attributeValueChanged().

int QgsAttributeTableModel::fieldIdx ( int col ) const

get field index from column

Definition at line 391 of file qgsattributetablemodel.cpp.

References mAttributes.

Referenced by executeAction().

void QgsAttributeTableModel::finished ( ) [signal]

Referenced by loadLayer().

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

Returns item flags for the index.

Parameters:

index model index

Definition at line 557 of file qgsattributetablemodel.cpp.

References QgsVectorLayer::Immutable, layer(), mAttributes, and mFieldCount.

Referenced by loadAttributes().

QVariant QgsAttributeTableModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

Returns header data.

Parameters:

section	required section
orientation	horizontal or vertical orientation
role	data role

Definition at line 413 of file qgsattributetablemodel.cpp.

References QgsVectorLayer::attributeAlias(), layer(), mAttributes, mFieldCount, QgsField::name(), QgsVectorLayer::pendingFields(), and tr.

QModelIndex QgsAttributeTableModel::idToIndex ( QgsFeatureId id ) const

Definition at line 361 of file qgsattributetablemodel.cpp.

References idToRow().

Referenced by QgsFeatureListModel::fidToIdx().

QModelIndexList QgsAttributeTableModel::idToIndexList ( QgsFeatureId id ) const

Definition at line 366 of file qgsattributetablemodel.cpp.

References columnCount(), and idToRow().

int QgsAttributeTableModel::idToRow ( QgsFeatureId id ) const

Maps feature id to table row.

Parameters:

id	feature id

Definition at line 350 of file qgsattributetablemodel.cpp.

References mIdRowMap, and QgsDebugMsg.

Referenced by attributeValueChanged(), featureDeleted(), idToIndex(), idToIndexList(), and swapRows().

QgsVectorLayer* QgsAttributeTableModel::layer ( ) const [inline]

Returns the layer this model uses as backend.

Retrieved from the layer cache.

Definition at line 164 of file qgsattributetablemodel.h.

Referenced by data(), executeAction(), flags(), headerData(), QgsAttributeTableDelegate::layer(), loadAttributes(), prefetchColumnData(), QgsAttributeTableModel(), and setData().

QgsVectorLayerCache* QgsAttributeTableModel::layerCache ( ) const [inline]

Returns the layer cache this model uses as backend.

Definition at line 169 of file qgsattributetablemodel.h.

Referenced by QgsAttributeTableFilterModel::generateListOfVisibleFeatures().

void QgsAttributeTableModel::layerDeleted ( ) [protected, virtual, slot]

Launched when layer has been deleted.

Definition at line 151 of file qgsattributetablemodel.cpp.

References mValueMaps, QgsDebugMsg, removeRows(), and rowCount().

Referenced by QgsAttributeTableModel().

void QgsAttributeTableModel::loadAttributes ( ) [protected, virtual]

Gets mFieldCount, mAttributes and mValueMaps.

Definition at line 180 of file qgsattributetablemodel.cpp.

References QgsFeature::attribute(), QgsFields::count(), data(), QgsVectorLayer::editType(), QgsExpression::evaluate(), QgsVectorLayer::fieldNameIndex(), flags(), QgsVectorLayer::getFeatures(), QgsExpression::hasParserError(), QgsVectorLayer::Hidden, QgsMapLayerRegistry::instance(), layer(), QgsMapLayerRegistry::mapLayer(), mAttributes, mFieldCount, QgsVectorLayer::ValueRelationData::mFilterExpression, QgsVectorLayer::ValueRelationData::mKey, QgsVectorLayer::ValueRelationData::mLayer, QgsVectorLayer::ValueRelationData::mValue, mValueMaps, QgsExpression::needsGeometry(), QgsFeatureRequest::NoFlags, QgsFeatureRequest::NoGeometry, QgsVectorLayer::pendingFields(), QgsExpression::prepare(), QgsExpression::referencedColumns(), QgsVectorLayer::ValueMap, QgsVectorLayer::ValueRelation, and QgsVectorLayer::valueRelation().

Referenced by QgsAttributeTableModel(), and updatedFields().

bool QgsAttributeTableModel::loadFeatureAtId ( QgsFeatureId fid ) const [private, virtual]

Load feature fid into local cache (mFeat)

Parameters:

fid	feature id

Returns:: feature exists

Definition at line 65 of file qgsattributetablemodel.cpp.

References QgsVectorLayerCache::featureAtId(), mFeat, MathUtils::min(), mLayerCache, and QgsDebugMsgLevel.

Referenced by data().

void QgsAttributeTableModel::loadLayer ( ) [virtual]

Loads the layer into the model Preferably to be called, before basing any other models on this model.

Definition at line 290 of file qgsattributetablemodel.cpp.

References featureAdded(), finished(), QgsVectorLayerCache::getFeatures(), QgsFeature::id(), mAttributes, mFeatureRequest, mFieldCount, mLayerCache, QgsFeatureIterator::nextFeature(), progress(), QgsDebugMsg, removeRows(), and rowCount().

Referenced by QgsDualView::initModels(), and QgsAttributeTableView::setCanvasAndLayerCache().

void QgsAttributeTableModel::modelChanged ( ) [signal]

Model has been changed.

Referenced by updatedFields().

void QgsAttributeTableModel::prefetchColumnData ( int column )

Caches the entire data for one column.

This should be called prior to sorting, so the data does not have to be fetched for every single comparison. Specify -1 as column to invalidate the cache

Parameters:

column The column index of the field to catch

Definition at line 610 of file qgsattributetablemodel.cpp.

References QgsFeature::attribute(), QgsVectorLayerCache::getFeatures(), QgsFeature::id(), layer(), mAttributes, mCachedField, mFieldCache, mLayerCache, QgsFeatureIterator::nextFeature(), QgsFeatureRequest::NoGeometry, and QgsVectorLayer::pendingFields().