QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Private Slots | Private Member Functions | Private Attributes | List of all members
QgsAttributeTableModel Class Reference

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

#include <qgsattributetablemodel.h>

Inheritance diagram for QgsAttributeTableModel:
Inheritance graph
[legend]
Collaboration diagram for QgsAttributeTableModel:
Collaboration graph
[legend]

Public Types

enum  Role { SortRole = Qt::UserRole + 1, FeatureIdRole = Qt::UserRole + 2, FieldIndexRole = Qt::UserRole + 3 }
 

Signals

void modelChanged ()
 Model has been changed. More...
 
void progress (int i, bool &cancel)
 
void finished ()
 

Public Member Functions

 QgsAttributeTableModel (QgsVectorLayerCache *layerCache, QObject *parent=0)
 Constructor. More...
 
virtual ~QgsAttributeTableModel ()
 
virtual void loadLayer ()
 Loads the layer into the model Preferably to be called, before basing any other models on this model. More...
 
virtual int rowCount (const QModelIndex &parent=QModelIndex()) const
 Returns the number of rows. More...
 
int columnCount (const QModelIndex &parent=QModelIndex()) const
 Returns the number of columns. More...
 
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 Returns header data. More...
 
virtual QVariant data (const QModelIndex &index, int role) const
 Returns data on the given index. More...
 
virtual bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
 Updates data on given index. More...
 
Qt::ItemFlags flags (const QModelIndex &index) const
 Returns item flags for the index. More...
 
void reload (const QModelIndex &index1, const QModelIndex &index2)
 Reloads the model data between indices. More...
 
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
 Remove rows. More...
 
void resetModel ()
 Resets the model. More...
 
int idToRow (QgsFeatureId id) const
 Maps feature id to table row. More...
 
QModelIndex idToIndex (QgsFeatureId id) const
 
QModelIndexList idToIndexList (QgsFeatureId id) const
 
int fieldIdx (int col) const
 get field index from column More...
 
int fieldCol (int idx) const
 get column from field index More...
 
QgsFeatureId rowToId (int row) const
 Maps row to feature id. More...
 
void swapRows (QgsFeatureId a, QgsFeatureId b)
 Swaps two rows. More...
 
QgsVectorLayerlayer () const
 Returns the layer this model uses as backend. More...
 
QgsVectorLayerCachelayerCache () const
 Returns the layer cache this model uses as backend. More...
 
void executeAction (int action, const QModelIndex &idx) const
 Execute an action. More...
 
void executeMapLayerAction (QgsMapLayerAction *action, const QModelIndex &idx) const
 Execute a QgsMapLayerAction. More...
 
QgsFeature feature (const QModelIndex &idx) const
 Return the feature attributes at given model index. More...
 
void prefetchColumnData (int column)
 Caches the entire data for one column. More...
 
void setRequest (const QgsFeatureRequest &request)
 

Protected Slots

virtual void attributeValueChanged (QgsFeatureId fid, int idx, const QVariant &value)
 Launched when attribute value has been changed. More...
 
virtual void featureDeleted (QgsFeatureId fid)
 Launched when a feature has been deleted. More...
 
virtual void featureAdded (QgsFeatureId fid)
 Launched when a feature has been added. More...
 
virtual void layerDeleted ()
 Launched when layer has been deleted. More...
 

Protected Member Functions

virtual void loadAttributes ()
 Gets mFieldCount, mAttributes and mValueMaps. More...
 

Protected Attributes

QgsVectorLayerCachemLayerCache
 
int mFieldCount
 
QgsFeature mFeat
 
QgsAttributeList mAttributes
 
QMap< int, const QMap< QString,
QVariant > * > 
mValueMaps
 
QHash< QgsFeatureId, int > mIdRowMap
 
QHash< int, QgsFeatureIdmRowIdMap
 

Private Slots

virtual void updatedFields ()
 Launched whenever the number of fields has changed. More...
 
virtual void editCommandEnded ()
 Gets called when an edit command ends This will synchronize all fields which have been changed since the last edit command in one single go. More...
 
virtual void attributeDeleted (int idx)
 Called whenever a column is removed;. More...
 

Private Member Functions

virtual bool loadFeatureAtId (QgsFeatureId fid) const
 Load feature fid into local cache (mFeat) More...
 

Private Attributes

QgsFeatureRequest mFeatureRequest
 
int mCachedField
 The currently cached column. More...
 
QHash< QgsFeatureId, QVariant > mFieldCache
 Allows to cache one specific column (used for sorting) More...
 
QRect mChangedCellBounds
 Holds the bounds of changed cells while an update operation is running top = min row left = min column bottom = max row right = max column. More...
 

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 43 of file qgsattributetablemodel.h.

Member Enumeration Documentation

Enumerator
SortRole 
FeatureIdRole 
FieldIndexRole 

Definition at line 48 of file qgsattributetablemodel.h.

Constructor & Destructor Documentation

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

Definition at line 62 of file qgsattributetablemodel.cpp.

References mValueMaps.

Member Function Documentation

void QgsAttributeTableModel::attributeDeleted ( int  idx)
privatevirtualslot

Called whenever a column is removed;.

Definition at line 173 of file qgsattributetablemodel.cpp.

References mCachedField, and prefetchColumnData().

Referenced by QgsAttributeTableModel().

void QgsAttributeTableModel::attributeValueChanged ( QgsFeatureId  fid,
int  idx,
const QVariant &  value 
)
protectedvirtualslot

Launched when attribute value has been changed.

Parameters
fidfeature id
idxattribute index
valuenew value

Definition at line 198 of file qgsattributetablemodel.cpp.

References QgsFeatureRequest::acceptFeature(), featureAdded(), featureDeleted(), fieldCol(), QgsFeatureRequest::FilterNone, QgsFeatureRequest::filterType(), idToRow(), index, loadFeatureAtId(), mCachedField, mFeat, mFeatureRequest, mFieldCache, mIdRowMap, QgsDebugMsgLevel, and setData().

Referenced by QgsAttributeTableModel().

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

Returns the number of columns.

Parameters
parentparent index

Definition at line 466 of file qgsattributetablemodel.cpp.

References mFieldCount.

Referenced by featureAdded(), and idToIndexList().

QVariant QgsAttributeTableModel::data ( const QModelIndex &  index,
int  role 
) const
virtual
void QgsAttributeTableModel::editCommandEnded ( )
privatevirtualslot

Gets called when an edit command ends This will synchronize all fields which have been changed since the last edit command in one single go.

Definition at line 165 of file qgsattributetablemodel.cpp.

References mChangedCellBounds, and reload().

Referenced by QgsAttributeTableModel().

void QgsAttributeTableModel::executeAction ( int  action,
const QModelIndex &  idx 
) const
void QgsAttributeTableModel::executeMapLayerAction ( QgsMapLayerAction action,
const QModelIndex &  idx 
) const
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 679 of file qgsattributetablemodel.cpp.

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

Referenced by executeAction(), and executeMapLayerAction().

void QgsAttributeTableModel::featureAdded ( QgsFeatureId  fid)
protectedvirtualslot
void QgsAttributeTableModel::featureDeleted ( QgsFeatureId  fid)
protectedvirtualslot

Launched when a feature has been deleted.

Parameters
fidfeature id

Definition at line 79 of file qgsattributetablemodel.cpp.

References QgsFeatureRequest::filterType(), idToRow(), mFeatureRequest, mFieldCache, and QgsDebugMsgLevel.

Referenced by attributeValueChanged(), and QgsAttributeTableModel().

int QgsAttributeTableModel::fieldCol ( int  idx) const

get column from field index

Definition at line 455 of file qgsattributetablemodel.cpp.

References mAttributes.

Referenced by attributeValueChanged().

int QgsAttributeTableModel::fieldIdx ( int  col) const

get field index from column

Definition at line 450 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
indexmodel index

Definition at line 638 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
sectionrequired section
orientationhorizontal or vertical orientation
roledata role

Definition at line 472 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 420 of file qgsattributetablemodel.cpp.

References idToRow(), and index.

Referenced by QgsFeatureListModel::fidToIdx().

QModelIndexList QgsAttributeTableModel::idToIndexList ( QgsFeatureId  id) const

Definition at line 425 of file qgsattributetablemodel.cpp.

References columnCount(), idToRow(), and index.

int QgsAttributeTableModel::idToRow ( QgsFeatureId  id) const

Maps feature id to table row.

Parameters
idfeature id

Definition at line 409 of file qgsattributetablemodel.cpp.

References mIdRowMap, and QgsDebugMsg.

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

QgsVectorLayer* QgsAttributeTableModel::layer ( ) const
inline
QgsVectorLayerCache* QgsAttributeTableModel::layerCache ( ) const
inline

Returns the layer cache this model uses as backend.

Definition at line 170 of file qgsattributetablemodel.h.

Referenced by QgsAttributeTableFilterModel::generateListOfVisibleFeatures().

void QgsAttributeTableModel::layerDeleted ( )
protectedvirtualslot

Launched when layer has been deleted.

Definition at line 181 of file qgsattributetablemodel.cpp.

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

Referenced by QgsAttributeTableModel().

void QgsAttributeTableModel::loadAttributes ( )
protectedvirtual
bool QgsAttributeTableModel::loadFeatureAtId ( QgsFeatureId  fid) const
privatevirtual

Load feature fid into local cache (mFeat)

Parameters
fidfeature id
Returns
feature exists

Definition at line 67 of file qgsattributetablemodel.cpp.

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

Referenced by attributeValueChanged(), data(), and featureAdded().

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 348 of file qgsattributetablemodel.cpp.

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

Referenced by QgsDualView::initModels().

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
columnThe column index of the field to catch

Definition at line 692 of file qgsattributetablemodel.cpp.

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

Referenced by attributeDeleted(), and QgsAttributeTableFilterModel::sort().

void QgsAttributeTableModel::progress ( int  i,
bool &  cancel 
)
signal
Note
not available in python bindings

Referenced by loadLayer().

void QgsAttributeTableModel::reload ( const QModelIndex &  index1,
const QModelIndex &  index2 
)

Reloads the model data between indices.

Parameters
index1start index
index2end index

Definition at line 655 of file qgsattributetablemodel.cpp.

References mFeat, MathUtils::min(), and QgsFeature::setFeatureId().

Referenced by editCommandEnded(), and featureAdded().

bool QgsAttributeTableModel::removeRows ( int  row,
int  count,
const QModelIndex &  parent = QModelIndex() 
)

Remove rows.

Definition at line 94 of file qgsattributetablemodel.cpp.

References FID_TO_STRING, mIdRowMap, mRowIdMap, and QgsDebugMsgLevel.

Referenced by layerDeleted(), and loadLayer().

void QgsAttributeTableModel::resetModel ( )

Resets the model.

Definition at line 661 of file qgsattributetablemodel.cpp.

int QgsAttributeTableModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const
virtual

Returns the number of rows.

Parameters
parentparent index

Definition at line 460 of file qgsattributetablemodel.cpp.

References mRowIdMap.

Referenced by featureAdded(), QgsDualView::featureCount(), layerDeleted(), and loadLayer().

QgsFeatureId QgsAttributeTableModel::rowToId ( int  row) const
bool QgsAttributeTableModel::setData ( const QModelIndex &  index,
const QVariant &  value,
int  role = Qt::EditRole 
)
virtual

Updates data on given index.

Parameters
indexmodel index
valuenew data value
roledata role

Definition at line 601 of file qgsattributetablemodel.cpp.

References QgsVectorLayer::isEditable(), QgsVectorLayer::isModified(), layer(), mChangedCellBounds, and mFieldCount.

Referenced by attributeValueChanged().

void QgsAttributeTableModel::setRequest ( const QgsFeatureRequest request)
void QgsAttributeTableModel::swapRows ( QgsFeatureId  a,
QgsFeatureId  b 
)

Swaps two rows.

Parameters
afirst row
bsecond row

Definition at line 386 of file qgsattributetablemodel.cpp.

References idToRow(), mIdRowMap, and mRowIdMap.

void QgsAttributeTableModel::updatedFields ( )
privatevirtualslot

Launched whenever the number of fields has changed.

Definition at line 158 of file qgsattributetablemodel.cpp.

References loadAttributes(), modelChanged(), and QgsDebugMsg.

Referenced by QgsAttributeTableModel().

Member Data Documentation

QgsAttributeList QgsAttributeTableModel::mAttributes
protected
int QgsAttributeTableModel::mCachedField
private

The currently cached column.

Definition at line 281 of file qgsattributetablemodel.h.

Referenced by attributeDeleted(), attributeValueChanged(), data(), featureAdded(), and prefetchColumnData().

QRect QgsAttributeTableModel::mChangedCellBounds
private

Holds the bounds of changed cells while an update operation is running top = min row left = min column bottom = max row right = max column.

Definition at line 292 of file qgsattributetablemodel.h.

Referenced by editCommandEnded(), and setData().

QgsFeature QgsAttributeTableModel::mFeat
mutableprotected
QgsFeatureRequest QgsAttributeTableModel::mFeatureRequest
private
QHash<QgsFeatureId, QVariant> QgsAttributeTableModel::mFieldCache
private

Allows to cache one specific column (used for sorting)

Definition at line 283 of file qgsattributetablemodel.h.

Referenced by attributeValueChanged(), data(), featureAdded(), featureDeleted(), and prefetchColumnData().

int QgsAttributeTableModel::mFieldCount
protected
QHash<QgsFeatureId, int> QgsAttributeTableModel::mIdRowMap
protected
QgsVectorLayerCache* QgsAttributeTableModel::mLayerCache
protected
QHash<int, QgsFeatureId> QgsAttributeTableModel::mRowIdMap
protected

Definition at line 261 of file qgsattributetablemodel.h.

Referenced by featureAdded(), removeRows(), rowCount(), rowToId(), and swapRows().

QMap< int, const QMap<QString, QVariant> * > QgsAttributeTableModel::mValueMaps
protected

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