QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
Signals | Public Member Functions | List of all members
QgsFeaturePickerModel Class Reference

Provides a list of features based on filter conditions. More...

#include <qgsfeaturepickermodel.h>

Inheritance diagram for QgsFeaturePickerModel:
Inheritance graph
[legend]

Signals

void featureChanged (const QgsFeature &feature)
 Emitted when the current feature changes. More...
 
- Signals inherited from QgsFeaturePickerModelBase
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 currentFeatureChanged ()
 Emitted when the current feature in the model has changed This emitted both when the extra value changes and when the extra value status changes. 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

 QgsFeaturePickerModel (QObject *parent=nullptr)
 Create a new QgsFeaturePickerModel, optionally specifying a parent. More...
 
QgsFeature feature () const
 Returns the current feature. 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 setFeature (const QgsFeatureId &fid)
 Set the feature to the given feature id. More...
 
- Public Member Functions inherited from QgsFeaturePickerModelBase
 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...
 
virtual void setExtraIdentifierValueToNull ()=0
 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 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...
 
QgsVectorLayersourceLayer () const
 The source layer from which features will be fetched. More...
 

Additional Inherited Members

- Public Types inherited from QgsFeaturePickerModelBase
enum  Role {
  IdentifierValueRole = Qt::UserRole , IdentifierValuesRole , ValueRole , FeatureRole ,
  FeatureIdRole
}
 Extra roles that can be used to fetch data from this model. More...
 
- Protected Member Functions inherited from QgsFeaturePickerModelBase
virtual bool compareEntries (const QgsFeatureExpressionValuesGatherer::Entry &a, const QgsFeatureExpressionValuesGatherer::Entry &b) const =0
 Returns true if the 2 entries refers to the same feature. More...
 
virtual QgsFeatureExpressionValuesGatherer::Entry createEntry (const QVariant &identifier) const =0
 Creates an entry with just the identifier so the feature can be retrieved in a next iteration. More...
 
virtual QgsFeatureExpressionValuesGatherer * createValuesGatherer (const QgsFeatureRequest &request) const =0
 Creates the value gatherer. More...
 
virtual QVariant entryIdentifier (const QgsFeatureExpressionValuesGatherer::Entry &entry) const =0
 Returns the identifier of the given entry. 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...
 
virtual bool identifierIsNull (const QVariant &identifier) const =0
 Returns true if the entry is null The identifier can be either the feature ID or the list of identifier fields. More...
 
virtual QVariant nullIdentifier () const =0
 Returns a null identifier. More...
 
virtual QSet< QString > requestedAttributes () const
 Returns the attributes to be fetched in the request. More...
 
virtual void requestToReloadCurrentFeature (QgsFeatureRequest &request)=0
 Update the request to match the current feature to be reloaded. 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...
 
- Protected Attributes inherited from QgsFeaturePickerModelBase
QVector< QgsFeatureExpressionValuesGatherer::Entry > mEntries
 
QVariant mExtraIdentifierValue
 The current identifier value. More...
 
int mExtraValueIndex = -1
 The current index. More...
 
- Properties inherited from QgsFeaturePickerModelBase
bool allowNull
 
QString displayExpression
 
int extraIdentifierValueIndex
 
bool fetchGeometry
 
int fetchLimit
 
QString filterExpression
 
QString filterValue
 
QgsVectorLayersourceLayer
 

Detailed Description

Provides a list of features based on filter conditions.

Features are fetched asynchronously.

Since
QGIS 3.0

Definition at line 31 of file qgsfeaturepickermodel.h.

Constructor & Destructor Documentation

◆ QgsFeaturePickerModel()

QgsFeaturePickerModel::QgsFeaturePickerModel ( QObject *  parent = nullptr)
explicit

Create a new QgsFeaturePickerModel, optionally specifying a parent.

Definition at line 24 of file qgsfeaturepickermodel.cpp.

Member Function Documentation

◆ feature()

QgsFeature QgsFeaturePickerModel::feature ( ) const

Returns the current feature.

Definition at line 74 of file qgsfeaturepickermodel.cpp.

◆ featureChanged

void QgsFeaturePickerModel::featureChanged ( const QgsFeature feature)
signal

Emitted when the current feature changes.

◆ setExtraIdentifierValueToNull()

void QgsFeaturePickerModel::setExtraIdentifierValueToNull ( )
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).

Since
QGIS 3.10

Implements QgsFeaturePickerModelBase.

Definition at line 64 of file qgsfeaturepickermodel.cpp.

◆ setFeature()

void QgsFeaturePickerModel::setFeature ( const QgsFeatureId fid)

Set the feature to the given feature id.

Definition at line 69 of file qgsfeaturepickermodel.cpp.


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