QGIS API Documentation
3.20.0-Odense (decaadbb31)
|
#include <qgsattributetablefiltermodel.h>
Public Types | |
enum | ColumnType { ColumnTypeField , ColumnTypeActionButton } |
The type of a column. More... | |
enum | FilterMode { ShowAll , ShowSelected , ShowVisible , ShowFilteredList , ShowEdited } |
The filter mode defines how the rows should be filtered. More... | |
enum | Role { TypeRole = QgsAttributeTableModel::UserRole } |
The additional roles defined by this filter model. More... | |
Public Slots | |
Q_DECL_DEPRECATED void | extentsChanged () |
Is called upon every change of the visible extents on the map canvas. More... | |
void | filterFeatures () |
Updates the filtered features in the filter model. More... | |
Signals | |
void | featuresFiltered () |
Emitted when the filtering of the features has been done. More... | |
void | filterError (const QString &errorMessage) |
Emitted when an error occurred while filtering features. More... | |
void | sortColumnChanged (int column, Qt::SortOrder order) |
Emitted whenever the sort column is changed. More... | |
void | visibleReloaded () |
Emitted when the the visible features on extend are reloaded (the list is created) More... | |
Public Member Functions | |
QgsAttributeTableFilterModel (QgsMapCanvas *canvas, QgsAttributeTableModel *sourceModel, QObject *parent=nullptr) | |
Make sure, the master model is already loaded, so the selection will get synchronized. More... | |
int | actionColumnIndex () const |
Gets the index of the first column that contains an action widget. More... | |
int | columnCount (const QModelIndex &parent) const override |
void | connectFilterModeConnections (FilterMode filterMode) |
Disconnect the connections set for the new filterMode. More... | |
QVariant | data (const QModelIndex &index, int role) const override |
void | disconnectFilterModeConnections () |
Disconnect the connections set for the current filterMode. More... | |
QModelIndex | fidToIndex (QgsFeatureId fid) override |
QModelIndexList | fidToIndexList (QgsFeatureId fid) |
QgsFeatureIds | filteredFeatures () |
Gets a list of currently filtered feature ids. More... | |
FilterMode | filterMode () |
The current filterModel. More... | |
Qt::ItemFlags | flags (const QModelIndex &index) const override |
QVariant | headerData (int section, Qt::Orientation orientation, int role) const override |
QgsVectorLayer * | layer () const |
Returns the layer this filter acts on. More... | |
QgsVectorLayerCache * | layerCache () const |
Returns the layerCache this filter acts on. More... | |
QgsMapCanvas * | mapCanvas () const |
Returns the map canvas. More... | |
QModelIndex | mapFromMaster (const QModelIndex &sourceIndex) const |
QModelIndex | mapFromSource (const QModelIndex &sourceIndex) const override |
QModelIndex | mapToMaster (const QModelIndex &proxyIndex) const |
QModelIndex | mapToSource (const QModelIndex &proxyIndex) const override |
QgsAttributeTableModel * | masterModel () const |
Returns the table model this filter is using. More... | |
QgsFeatureId | rowToId (const QModelIndex &row) |
Returns the feature id for a given model index. More... | |
bool | selectedOnTop () |
Returns if selected features are currently shown on top. More... | |
void | setAttributeTableConfig (const QgsAttributeTableConfig &config) |
Set the attribute table configuration to control which fields are shown, in which order they are shown as well as if and where an action column is shown. More... | |
virtual void | setFilteredFeatures (const QgsFeatureIds &ids) |
Specify a list of features, which the filter will accept. More... | |
void | setFilterExpression (const QgsExpression &expression, const QgsExpressionContext &context) |
Set the expression and the context to be stored in case of the features need to be filtered again (like on filter or on main model data change). More... | |
void | setFilterMode (FilterMode filterMode) |
Set the filter mode the filter will use. More... | |
void | setSelectedOnTop (bool selectedOnTop) |
Changes the sort order of the features. More... | |
void | setSourceModel (QgsAttributeTableModel *sourceModel) |
Set the attribute table model that backs this model. More... | |
void | sort (const QString &expression, Qt::SortOrder order=Qt::AscendingOrder) |
Sort by the given expression using the given order. More... | |
void | sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override |
Sort by the given column using the given order. More... | |
QString | sortExpression () const |
The expression which is used to sort the attribute table. More... | |
Public Member Functions inherited from QgsFeatureModel | |
virtual | ~QgsFeatureModel ()=default |
Protected Member Functions | |
bool | filterAcceptsRow (int sourceRow, const QModelIndex &sourceParent) const override |
Returns true if the source row will be accepted. More... | |
void | generateListOfVisibleFeatures () |
Updates the list of currently visible features on the map canvas. More... | |
bool | lessThan (const QModelIndex &left, const QModelIndex &right) const override |
Used by the sorting algorithm. More... | |
Definition at line 36 of file qgsattributetablefiltermodel.h.
The type of a column.
Enumerator | |
---|---|
ColumnTypeField | This column shows a field. |
ColumnTypeActionButton | This column shows action buttons. |
Definition at line 58 of file qgsattributetablefiltermodel.h.
The filter mode defines how the rows should be filtered.
Enumerator | |
---|---|
ShowAll | Show all features. |
ShowSelected | Show only selected features. |
ShowVisible | Show only visible features (depends on the map canvas) |
ShowFilteredList | Show only features whose ids are on the filter list. {.
|
ShowEdited | Show only features which have unsaved changes. |
Definition at line 45 of file qgsattributetablefiltermodel.h.
The additional roles defined by this filter model.
The values of these roles start just after the roles defined by QgsAttributeTableModel so they do not conflict.
Enumerator | |
---|---|
TypeRole | The type of a given column. |
Definition at line 70 of file qgsattributetablefiltermodel.h.
QgsAttributeTableFilterModel::QgsAttributeTableFilterModel | ( | QgsMapCanvas * | canvas, |
QgsAttributeTableModel * | sourceModel, | ||
QObject * | parent = nullptr |
||
) |
Make sure, the master model is already loaded, so the selection will get synchronized.
parent | parent object (owner) |
sourceModel | The QgsAttributeTableModel to use as source (mostly referred to as master model) |
canvas | The mapCanvas. Used to identify the currently visible features. |
Definition at line 37 of file qgsattributetablefiltermodel.cpp.
int QgsAttributeTableFilterModel::actionColumnIndex | ( | ) | const |
Gets the index of the first column that contains an action widget.
Returns -1 if none is defined.
Definition at line 135 of file qgsattributetablefiltermodel.cpp.
|
override |
Definition at line 140 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::connectFilterModeConnections | ( | QgsAttributeTableFilterModel::FilterMode | filterMode | ) |
Disconnect the connections set for the new filterMode.
Definition at line 364 of file qgsattributetablefiltermodel.cpp.
|
override |
Definition at line 96 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::disconnectFilterModeConnections | ( | ) |
Disconnect the connections set for the current filterMode.
Definition at line 341 of file qgsattributetablefiltermodel.cpp.
|
slot |
Is called upon every change of the visible extents on the map canvas.
When a change is signalled, the filter is updated and invalidated if needed.
Definition at line 433 of file qgsattributetablefiltermodel.cpp.
|
signal |
Emitted when the filtering of the features has been done.
|
overridevirtual |
Implements QgsFeatureModel.
Definition at line 675 of file qgsattributetablefiltermodel.cpp.
QModelIndexList QgsAttributeTableFilterModel::fidToIndexList | ( | QgsFeatureId | fid | ) |
Definition at line 680 of file qgsattributetablefiltermodel.cpp.
|
overrideprotected |
Returns true
if the source row will be accepted.
sourceRow | row from the source model |
sourceParent | parent index in the source model |
Definition at line 388 of file qgsattributetablefiltermodel.cpp.
QgsFeatureIds QgsAttributeTableFilterModel::filteredFeatures | ( | ) |
Gets a list of currently filtered feature ids.
Definition at line 318 of file qgsattributetablefiltermodel.cpp.
|
signal |
Emitted when an error occurred while filtering features.
|
slot |
Updates the filtered features in the filter model.
It is called when the data of the main table or the filter expression changed.
Definition at line 474 of file qgsattributetablefiltermodel.cpp.
|
inline |
The current filterModel.
Definition at line 144 of file qgsattributetablefiltermodel.h.
|
override |
Definition at line 722 of file qgsattributetablefiltermodel.cpp.
|
protected |
Updates the list of currently visible features on the map canvas.
Is called automatically when the filter mode is adjusted or the extents changed.
Definition at line 574 of file qgsattributetablefiltermodel.cpp.
|
override |
Definition at line 114 of file qgsattributetablefiltermodel.cpp.
|
inline |
Returns the layer this filter acts on.
Definition at line 151 of file qgsattributetablefiltermodel.h.
|
inline |
Returns the layerCache this filter acts on.
Definition at line 158 of file qgsattributetablefiltermodel.h.
|
overrideprotected |
Used by the sorting algorithm.
Compares the two model indices. Will also consider the selection state of the feature in case selected features are to be shown on top.
Definition at line 52 of file qgsattributetablefiltermodel.cpp.
|
inline |
Returns the map canvas.
Definition at line 214 of file qgsattributetablefiltermodel.h.
|
inline |
Definition at line 182 of file qgsattributetablefiltermodel.h.
|
override |
Definition at line 707 of file qgsattributetablefiltermodel.cpp.
|
inline |
Definition at line 180 of file qgsattributetablefiltermodel.h.
|
override |
Definition at line 692 of file qgsattributetablefiltermodel.cpp.
|
inline |
Returns the table model this filter is using.
Definition at line 165 of file qgsattributetablefiltermodel.h.
QgsFeatureId QgsAttributeTableFilterModel::rowToId | ( | const QModelIndex & | row | ) |
Returns the feature id for a given model index.
row | A model index of the row in question |
Definition at line 670 of file qgsattributetablefiltermodel.cpp.
bool QgsAttributeTableFilterModel::selectedOnTop | ( | ) |
Returns if selected features are currently shown on top.
true
if selected are shown on top Definition at line 306 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::setAttributeTableConfig | ( | const QgsAttributeTableConfig & | config | ) |
Set the attribute table configuration to control which fields are shown, in which order they are shown as well as if and where an action column is shown.
Definition at line 146 of file qgsattributetablefiltermodel.cpp.
|
virtual |
Specify a list of features, which the filter will accept.
The filter mode will automatically be adjusted to show only these features (ShowFilteredList).
ids | The list of feature ids which will be accepted by the filter |
Definition at line 311 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::setFilterExpression | ( | const QgsExpression & | expression, |
const QgsExpressionContext & | context | ||
) |
Set the expression and the context to be stored in case of the features need to be filtered again (like on filter or on main model data change).
Definition at line 243 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::setFilterMode | ( | FilterMode | filterMode | ) |
Set the filter mode the filter will use.
filterMode | Sets the current mode of the filter |
Definition at line 330 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::setSelectedOnTop | ( | bool | selectedOnTop | ) |
Changes the sort order of the features.
If set to true
, selected features will be sorted on top, regardless of the current sort column
selectedOnTop | Specify, if selected features should be sorted on top |
Definition at line 264 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::setSourceModel | ( | QgsAttributeTableModel * | sourceModel | ) |
Set the attribute table model that backs this model.
sourceModel | The model |
Definition at line 284 of file qgsattributetablefiltermodel.cpp.
void QgsAttributeTableFilterModel::sort | ( | const QString & | expression, |
Qt::SortOrder | order = Qt::AscendingOrder |
||
) |
Sort by the given expression using the given order.
Prefetches all the data from the layer to speed up sorting.
expression | The expression which should be used for sorting |
order | The order ( Qt::AscendingOrder or Qt::DescendingOrder ) |
Definition at line 249 of file qgsattributetablefiltermodel.cpp.
|
override |
Sort by the given column using the given order.
Prefetches all the data from the layer to speed up sorting.
column | The column which should be sorted |
order | The order ( Qt::AscendingOrder or Qt::DescendingOrder ) |
Definition at line 79 of file qgsattributetablefiltermodel.cpp.
|
signal |
Emitted whenever the sort column is changed.
column | The sort column |
order | The sort order |
QString QgsAttributeTableFilterModel::sortExpression | ( | ) | const |
The expression which is used to sort the attribute table.
Definition at line 259 of file qgsattributetablefiltermodel.cpp.
|
signal |
Emitted when the the visible features on extend are reloaded (the list is created)