QGIS API Documentation
3.0.2-Girona (307d082)
|
A model backed by a QgsVectorLayerCache which is able to provide feature/attribute information to a QAbstractItemView. More...
#include <qgsattributetablemodel.h>
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... | |
QVariant | data (const QModelIndex &index, int role) const override |
Returns data on the given index. More... | |
const QgsAttributeEditorContext & | editorContext () const |
Returns the context in which this table is shown. More... | |
void | executeAction (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... | |
QgsVectorLayer * | layer () const |
Returns the layer this model uses as backend. More... | |
QgsVectorLayerCache * | layerCache () 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 QgsFeatureRequest & | request () const |
Get the the feature request. More... | |
void | resetModel () |
Resets the model. More... | |
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... | |
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... | |
Friends | |
class | TestQgsAttributeTable |
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.
Definition at line 50 of file qgsattributetablemodel.h.
Definition at line 55 of file qgsattributetablemodel.h.
QgsAttributeTableModel::QgsAttributeTableModel | ( | QgsVectorLayerCache * | layerCache, |
QObject * | parent = nullptr |
||
) |
Constructor.
layerCache | A layer cache to use as backend |
parent | The parent QObject (owner) |
Definition at line 46 of file qgsattributetablemodel.cpp.
|
override |
Returns the number of columns.
parent | parent index |
Definition at line 552 of file qgsattributetablemodel.cpp.
|
override |
Returns data on the given index.
index | model index |
role | data role |
Definition at line 598 of file qgsattributetablemodel.cpp.
|
inline |
Returns the context in which this table is shown.
Will be forwarded to any editor widget created when editing data on this model.
Definition at line 242 of file qgsattributetablemodel.h.
void QgsAttributeTableModel::executeAction | ( | QUuid | action, |
const QModelIndex & | idx | ||
) | const |
Execute an action.
Definition at line 785 of file qgsattributetablemodel.cpp.
void QgsAttributeTableModel::executeMapLayerAction | ( | QgsMapLayerAction * | action, |
const QModelIndex & | idx | ||
) | const |
Execute a QgsMapLayerAction.
Definition at line 791 of file qgsattributetablemodel.cpp.
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 88 of file qgsattributetablemodel.cpp.
QgsFeature QgsAttributeTableModel::feature | ( | const QModelIndex & | idx | ) | const |
Return the feature attributes at given model index.
Definition at line 797 of file qgsattributetablemodel.cpp.
int QgsAttributeTableModel::fieldCol | ( | int | idx | ) | const |
get column from field index
Definition at line 541 of file qgsattributetablemodel.cpp.
|
slot |
Handles updating the model when the conditional style for a field changes.
fieldName | name of field whose conditional style has changed |
Definition at line 450 of file qgsattributetablemodel.cpp.
int QgsAttributeTableModel::fieldIdx | ( | int | col | ) | const |
get field index from column
Definition at line 536 of file qgsattributetablemodel.cpp.
|
signal |
|
override |
Returns item flags for the index.
index | model index |
Definition at line 741 of file qgsattributetablemodel.cpp.
|
override |
Returns header data.
section | required section |
orientation | horizontal or vertical orientation |
role | data role |
Definition at line 558 of file qgsattributetablemodel.cpp.
QModelIndex QgsAttributeTableModel::idToIndex | ( | QgsFeatureId | id | ) | const |
Definition at line 504 of file qgsattributetablemodel.cpp.
QModelIndexList QgsAttributeTableModel::idToIndexList | ( | QgsFeatureId | id | ) | const |
Definition at line 509 of file qgsattributetablemodel.cpp.
int QgsAttributeTableModel::idToRow | ( | QgsFeatureId | id | ) | const |
Maps feature id to table row.
id | feature id |
Definition at line 493 of file qgsattributetablemodel.cpp.
|
inline |
Returns the layer this model uses as backend.
Retrieved from the layer cache.
Definition at line 168 of file qgsattributetablemodel.h.
|
inline |
Returns the layer cache this model uses as backend.
Definition at line 173 of file qgsattributetablemodel.h.
|
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 405 of file qgsattributetablemodel.cpp.
|
signal |
Model has been changed.
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
column | The column index of the field to catch |
Definition at line 810 of file qgsattributetablemodel.cpp.
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.
expression | The expression to cache |
Definition at line 822 of file qgsattributetablemodel.cpp.
|
signal |
void QgsAttributeTableModel::reload | ( | const QModelIndex & | index1, |
const QModelIndex & | index2 | ||
) |
Reloads the model data between indices.
index1 | start index |
index2 | end index |
Definition at line 778 of file qgsattributetablemodel.cpp.
|
override |
Remove rows.
Definition at line 155 of file qgsattributetablemodel.cpp.
const QgsFeatureRequest & QgsAttributeTableModel::request | ( | ) | const |
Get the the feature request.
Definition at line 900 of file qgsattributetablemodel.cpp.
|
inline |
|
override |
Returns the number of rows.
parent | parent index |
Definition at line 546 of file qgsattributetablemodel.cpp.
QgsFeatureId QgsAttributeTableModel::rowToId | ( | int | row | ) | const |
Maps row to feature id.
row | row number |
Definition at line 524 of file qgsattributetablemodel.cpp.
|
override |
Updates data on given index.
index | model index |
value | new data value |
role | data role |
Definition at line 704 of file qgsattributetablemodel.cpp.
|
inline |
Sets the context in which this table is shown.
Will be forwarded to any editor widget created when editing data on this model.
context | The context |
Definition at line 234 of file qgsattributetablemodel.h.
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 93 of file qgsattributetablemodel.cpp.
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.
request | The request to use to fill this table model. |
Definition at line 893 of file qgsattributetablemodel.cpp.
QString QgsAttributeTableModel::sortCacheExpression | ( | ) | const |
The expression which was used to fill the sorting cache.
Definition at line 885 of file qgsattributetablemodel.cpp.
void QgsAttributeTableModel::swapRows | ( | QgsFeatureId | a, |
QgsFeatureId | b | ||
) |
Swaps two rows.
a | first row |
b | second row |
Definition at line 468 of file qgsattributetablemodel.cpp.
|
friend |
Definition at line 387 of file qgsattributetablemodel.h.