QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsfeaturefiltermodel.h>
Signals | |
void | extraIdentifierValuesChanged () |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model. More... | |
void | identifierFieldsChanged () |
The identifier field should be a unique field that can be used to identify individual features. More... | |
![]() | |
void | allowNullChanged () |
Add a NULL entry to the list. More... | |
void | beginUpdate () |
Notification that the model is about to be changed because a job was completed. More... | |
void | displayExpressionChanged () |
The display expression will be used for. More... | |
void | endUpdate () |
Notification that the model change is finished. More... | |
void | extraIdentifierValueChanged () |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model. More... | |
void | extraIdentifierValueIndexChanged (int index) |
The index at which the extra identifier value is available within the model. More... | |
void | extraValueDoesNotExistChanged () |
Flag indicating that the extraIdentifierValue does not exist in the data. More... | |
void | fetchGeometryChanged () |
Emitted when the fetching of the geometry changes. More... | |
void | fetchLimitChanged () |
Emitted when the fetching limit for the feature request changes. More... | |
void | filterExpressionChanged () |
An additional filter expression to apply, next to the filterValue. More... | |
void | filterJobCompleted () |
Indicates that a filter job has been completed and new data may be available. More... | |
void | filterValueChanged () |
This value will be used to filter the features available from this model. More... | |
void | isLoadingChanged () |
Indicator if the model is currently performing any feature iteration in the background. More... | |
void | sourceLayerChanged () |
The source layer from which features will be fetched. More... | |
Public Member Functions | |
QgsFeatureFilterModel (QObject *parent=nullptr) | |
Create a new QgsFeatureFilterModel, optionally specifying a parent. More... | |
QVariantList | extraIdentifierValues () const |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model. More... | |
Q_DECL_DEPRECATED QString | identifierField () const |
The identifier field should be a unique field that can be used to identify individual features. More... | |
QStringList | identifierFields () const |
The identifier field should be a unique field that can be used to identify individual features. More... | |
void | setExtraIdentifierValues (const QVariantList &extraIdentifierValues) |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model. More... | |
void | setExtraIdentifierValueToNull () override |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model as NULL value(s). More... | |
void | setIdentifierFields (const QStringList &identifierFields) |
The identifier field should be a unique field that can be used to identify individual features. More... | |
![]() | |
QgsFeaturePickerModelBase (QObject *parent=nullptr) | |
Create a new QgsFeaturePickerModelBase, optionally specifying a parent. More... | |
~QgsFeaturePickerModelBase () override | |
bool | allowNull () const |
Add a NULL entry to the list. More... | |
int | columnCount (const QModelIndex &parent) const override |
QVariant | data (const QModelIndex &index, int role) const override |
QString | displayExpression () const |
The display expression will be used for. More... | |
int | extraIdentifierValueIndex () const |
The index at which the extra identifier value is available within the model. More... | |
bool | extraValueDoesNotExist () const |
Flag indicating that the extraIdentifierValue does not exist in the data. More... | |
bool | fetchGeometry () const |
Returns if the geometry is fetched. More... | |
int | fetchLimit () const |
Returns the feature request fetch limit. More... | |
QString | filterExpression () const |
An additional filter expression to apply, next to the filterValue. More... | |
QString | filterValue () const |
This value will be used to filter the features available from this model. More... | |
QModelIndex | index (int row, int column, const QModelIndex &parent) const override |
bool | isLoading () const |
Indicator if the model is currently performing any feature iteration in the background. More... | |
QModelIndex | parent (const QModelIndex &child) const override |
int | rowCount (const QModelIndex &parent) const override |
void | setAllowNull (bool allowNull) |
Add a NULL entry to the list. More... | |
void | setDisplayExpression (const QString &displayExpression) |
The display expression will be used for. More... | |
void | setFetchGeometry (bool fetchGeometry) |
Defines if the geometry will be fetched. More... | |
void | setFetchLimit (int fetchLimit) |
Defines the feature request fetch limit If set to 0, no limit is applied when fetching. More... | |
void | setFilterExpression (const QString &filterExpression) |
An additional filter expression to apply, next to the filterValue. More... | |
void | setFilterValue (const QString &filterValue) |
This value will be used to filter the features available from this model. More... | |
void | setSourceLayer (QgsVectorLayer *sourceLayer) |
The source layer from which features will be fetched. More... | |
QgsVectorLayer * | sourceLayer () const |
The source layer from which features will be fetched. More... | |
Properties | |
QVariantList | extraIdentifierValues |
The values that identifies the current feature. More... | |
QStringList | identifierFields |
A set of fields of sourceLayer that is unique and should be used to identify features. More... | |
![]() | |
bool | allowNull |
QString | displayExpression |
int | extraIdentifierValueIndex |
bool | fetchGeometry |
int | fetchLimit |
QString | filterExpression |
QString | filterValue |
QgsVectorLayer | sourceLayer |
Additional Inherited Members | |
![]() | |
enum | Role { IdentifierValueRole = Qt::UserRole, IdentifierValuesRole, ValueRole, FeatureRole, FeatureIdRole } |
Extra roles that can be used to fetch data from this model. More... | |
![]() | |
QVariant | extraIdentifierValue () const |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model. More... | |
void | setExtraIdentifierValue (const QVariant &extraIdentifierValue) |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model. More... | |
void | setExtraIdentifierValueUnguarded (const QVariant &identifierValue) |
This will set the identifier value to be set in the model even if it doesn't exist currently in the data. More... | |
![]() | |
QVector< QgsFeatureExpressionValuesGatherer::Entry > | mEntries |
QVariant | mExtraIdentifierValue |
The current identifier value. More... | |
int | mExtraValueIndex = -1 |
The current index. More... | |
Provides a list of features based on filter conditions. Features are fetched asynchronously.
Definition at line 28 of file qgsfeaturefiltermodel.h.
|
explicit |
Create a new QgsFeatureFilterModel, optionally specifying a parent.
Definition at line 38 of file qgsfeaturefiltermodel.cpp.
QVariantList QgsFeatureFilterModel::extraIdentifierValues | ( | ) | const |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model.
|
signal |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model.
QString QgsFeatureFilterModel::identifierField | ( | ) | const |
The identifier field should be a unique field that can be used to identify individual features.
It is normally set to the primary key of the layer. If there are several identifier fields defined, the behavior is not guaranteed
Definition at line 46 of file qgsfeaturefiltermodel.cpp.
QStringList QgsFeatureFilterModel::identifierFields | ( | ) | const |
The identifier field should be a unique field that can be used to identify individual features.
It is normally set to the primary key of the layer.
|
signal |
The identifier field should be a unique field that can be used to identify individual features.
It is normally set to the primary key of the layer.
void QgsFeatureFilterModel::setExtraIdentifierValues | ( | const QVariantList & | extraIdentifierValues | ) |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model.
Definition at line 147 of file qgsfeaturefiltermodel.cpp.
|
overridevirtual |
Allows specifying one value that does not need to match the filter criteria but will still be available in the model as NULL value(s).
Implements QgsFeaturePickerModelBase.
Definition at line 152 of file qgsfeaturefiltermodel.cpp.
void QgsFeatureFilterModel::setIdentifierFields | ( | const QStringList & | identifierFields | ) |
The identifier field should be a unique field that can be used to identify individual features.
It is normally set to the primary key of the layer.
Definition at line 121 of file qgsfeaturefiltermodel.cpp.
|
readwrite |
The values that identifies the current feature.
Definition at line 55 of file qgsfeaturefiltermodel.h.
|
readwrite |
A set of fields of sourceLayer that is unique and should be used to identify features.
Normally the primary key field. Needs to match the identifierValue.
Definition at line 50 of file qgsfeaturefiltermodel.h.