QGIS API Documentation  2.99.0-Master (b8fd1fd)
Public Types | Public Slots | Signals | Public Member Functions | 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]

Public Types

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

Public Slots

void fieldConditionalStyleChanged (const QString &fieldName)
 Handles updating the model when the conditional style for a field changes. More...
 
virtual void loadLayer ()
 Loads the layer into the model Preferably to be called, before using this model as source for any other proxy model. More...
 

Signals

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

Public Member Functions

 QgsAttributeTableModel (QgsVectorLayerCache *layerCache, QObject *parent=nullptr)
 Constructor. More...
 
int columnCount (const QModelIndex &parent=QModelIndex()) const override
 Returns the number of columns. More...
 
virtual QVariant data (const QModelIndex &index, int role) const override
 Returns data on the given index. More...
 
const QgsAttributeEditorContexteditorContext () const
 Returns the context in which this table is shown. More...
 
void executeAction (const QUuid &action, const QModelIndex &idx) const
 Execute an action. More...
 
void executeMapLayerAction (QgsMapLayerAction *action, const QModelIndex &idx) const
 Execute a QgsMapLayerAction. More...
 
int extraColumns () const
 Empty extra columns to announce from this model. More...
 
QgsFeature feature (const QModelIndex &idx) const
 Return the feature attributes at given model index. More...
 
int fieldCol (int idx) const
 get column from field index More...
 
int fieldIdx (int col) const
 get field index from column More...
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 Returns item flags for the index. More...
 
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
 Returns header data. More...
 
QModelIndex idToIndex (QgsFeatureId id) const
 
QModelIndexList idToIndexList (QgsFeatureId id) const
 
int idToRow (QgsFeatureId id) const
 Maps feature id to table row. 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 prefetchColumnData (int column)
 Caches the entire data for one column. More...
 
void prefetchSortData (const QString &expression)
 Prefetches the entire data for one expression. 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()) override
 Remove rows. More...
 
const QgsFeatureRequestrequest () const
 Get the the feature request. More...
 
void resetModel ()
 Resets the model. More...
 
virtual int rowCount (const QModelIndex &parent=QModelIndex()) const override
 Returns the number of rows. More...
 
QgsFeatureId rowToId (int row) const
 Maps row to feature id. More...
 
virtual bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
 Updates data on given index. More...
 
void setEditorContext (const QgsAttributeEditorContext &context)
 Sets the context in which this table is shown. More...
 
void setExtraColumns (int extraColumns)
 Empty extra columns to announce from this model. More...
 
void setRequest (const QgsFeatureRequest &request)
 Set a request that will be used to fill this attribute table model. More...
 
QString sortCacheExpression () const
 The expression which was used to fill the sorting cache. More...
 
void swapRows (QgsFeatureId a, QgsFeatureId b)
 Swaps two rows. 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 48 of file qgsattributetablemodel.h.

Member Enumeration Documentation

◆ Role

Enumerator
SortRole 

Role used for sorting.

FeatureIdRole 

Get the feature id of the feature in this row.

FieldIndexRole 

Get the field index of this column.

UserRole 

Start further roles starting from this role.

Definition at line 53 of file qgsattributetablemodel.h.

Constructor & Destructor Documentation

◆ QgsAttributeTableModel()

QgsAttributeTableModel::QgsAttributeTableModel ( QgsVectorLayerCache layerCache,
QObject *  parent = nullptr 
)

Constructor.

Parameters
layerCacheA layer cache to use as backend
parentThe parent QObject (owner)

Definition at line 41 of file qgsattributetablemodel.cpp.

Member Function Documentation

◆ columnCount()

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

Returns the number of columns.

Parameters
parentparent index

Definition at line 538 of file qgsattributetablemodel.cpp.

◆ data()

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

Returns data on the given index.

Parameters
indexmodel index
roledata role

Definition at line 584 of file qgsattributetablemodel.cpp.

◆ editorContext()

const QgsAttributeEditorContext& QgsAttributeTableModel::editorContext ( ) const
inline

Returns the context in which this table is shown.

Will be forwarded to any editor widget created when editing data on this model.

Returns
The context

Definition at line 240 of file qgsattributetablemodel.h.

◆ executeAction()

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

Execute an action.

Definition at line 751 of file qgsattributetablemodel.cpp.

◆ executeMapLayerAction()

void QgsAttributeTableModel::executeMapLayerAction ( QgsMapLayerAction action,
const QModelIndex &  idx 
) const

Execute a QgsMapLayerAction.

Definition at line 757 of file qgsattributetablemodel.cpp.

◆ extraColumns()

int QgsAttributeTableModel::extraColumns ( ) const

Empty extra columns to announce from this model.

Any extra columns need to be implemented by proxy models in front of this model.

Definition at line 84 of file qgsattributetablemodel.cpp.

◆ feature()

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

◆ fieldCol()

int QgsAttributeTableModel::fieldCol ( int  idx) const

get column from field index

Definition at line 527 of file qgsattributetablemodel.cpp.

◆ fieldConditionalStyleChanged

void QgsAttributeTableModel::fieldConditionalStyleChanged ( const QString &  fieldName)
slot

Handles updating the model when the conditional style for a field changes.

Parameters
fieldNamename of field whose conditional style has changed
Note
added in QGIS 2.12

Definition at line 438 of file qgsattributetablemodel.cpp.

◆ fieldIdx()

int QgsAttributeTableModel::fieldIdx ( int  col) const

get field index from column

Definition at line 522 of file qgsattributetablemodel.cpp.

◆ finished

void QgsAttributeTableModel::finished ( )
signal

◆ flags()

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

Returns item flags for the index.

Parameters
indexmodel index

Definition at line 725 of file qgsattributetablemodel.cpp.

◆ headerData()

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

Returns header data.

Parameters
sectionrequired section
orientationhorizontal or vertical orientation
roledata role

Definition at line 544 of file qgsattributetablemodel.cpp.

◆ idToIndex()

QModelIndex QgsAttributeTableModel::idToIndex ( QgsFeatureId  id) const

Definition at line 490 of file qgsattributetablemodel.cpp.

◆ idToIndexList()

QModelIndexList QgsAttributeTableModel::idToIndexList ( QgsFeatureId  id) const

Definition at line 495 of file qgsattributetablemodel.cpp.

◆ idToRow()

int QgsAttributeTableModel::idToRow ( QgsFeatureId  id) const

Maps feature id to table row.

Parameters
idfeature id

Definition at line 479 of file qgsattributetablemodel.cpp.

◆ layer()

QgsVectorLayer* QgsAttributeTableModel::layer ( ) const
inline

Returns the layer this model uses as backend.

Retrieved from the layer cache.

Definition at line 166 of file qgsattributetablemodel.h.

◆ layerCache()

QgsVectorLayerCache* QgsAttributeTableModel::layerCache ( ) const
inline

Returns the layer cache this model uses as backend.

Definition at line 171 of file qgsattributetablemodel.h.

◆ loadLayer

void QgsAttributeTableModel::loadLayer ( )
virtualslot

Loads the layer into the model Preferably to be called, before using this model as source for any other proxy model.

Definition at line 393 of file qgsattributetablemodel.cpp.

◆ modelChanged

void QgsAttributeTableModel::modelChanged ( )
signal

Model has been changed.

◆ prefetchColumnData()

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

◆ prefetchSortData()

void QgsAttributeTableModel::prefetchSortData ( const QString &  expression)

Prefetches the entire data for one expression.

Based on this cached information the sorting can later be done in a performant way.

Parameters
expressionThe expression to cache

Definition at line 788 of file qgsattributetablemodel.cpp.

◆ progress

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

◆ reload()

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

Reloads the model data between indices.

Parameters
index1start index
index2end index

Definition at line 744 of file qgsattributetablemodel.cpp.

◆ removeRows()

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

Remove rows.

Definition at line 151 of file qgsattributetablemodel.cpp.

◆ request()

const QgsFeatureRequest & QgsAttributeTableModel::request ( ) const

Get the the feature request.

Definition at line 859 of file qgsattributetablemodel.cpp.

◆ resetModel()

void QgsAttributeTableModel::resetModel ( )
inline

Resets the model.

Alias to loadLayer()

Definition at line 128 of file qgsattributetablemodel.h.

◆ rowCount()

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

Returns the number of rows.

Parameters
parentparent index

Definition at line 532 of file qgsattributetablemodel.cpp.

◆ rowToId()

QgsFeatureId QgsAttributeTableModel::rowToId ( int  row) const

Maps row to feature id.

Parameters
rowrow number

Definition at line 510 of file qgsattributetablemodel.cpp.

◆ setData()

bool QgsAttributeTableModel::setData ( const QModelIndex &  index,
const QVariant &  value,
int  role = Qt::EditRole 
)
overridevirtual

Updates data on given index.

Parameters
indexmodel index
valuenew data value
roledata role

Definition at line 688 of file qgsattributetablemodel.cpp.

◆ setEditorContext()

void QgsAttributeTableModel::setEditorContext ( const QgsAttributeEditorContext context)
inline

Sets the context in which this table is shown.

Will be forwarded to any editor widget created when editing data on this model.

Parameters
contextThe context

Definition at line 232 of file qgsattributetablemodel.h.

◆ setExtraColumns()

void QgsAttributeTableModel::setExtraColumns ( int  extraColumns)

Empty extra columns to announce from this model.

Any extra columns need to be implemented by proxy models in front of this model.

Definition at line 89 of file qgsattributetablemodel.cpp.

◆ setRequest()

void QgsAttributeTableModel::setRequest ( const QgsFeatureRequest request)

Set a request that will be used to fill this attribute table model.

In contrast to a filter, the request will constrain the data shown without the possibility to dynamically adjust it.

Parameters
requestThe request to use to fill this table model.

Definition at line 852 of file qgsattributetablemodel.cpp.

◆ sortCacheExpression()

QString QgsAttributeTableModel::sortCacheExpression ( ) const

The expression which was used to fill the sorting cache.

Definition at line 844 of file qgsattributetablemodel.cpp.

◆ swapRows()

void QgsAttributeTableModel::swapRows ( QgsFeatureId  a,
QgsFeatureId  b 
)

Swaps two rows.

Parameters
afirst row
bsecond row

Definition at line 456 of file qgsattributetablemodel.cpp.


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