17#include "moc_qgsfeaturepickermodelbase.cpp"
26 : QAbstractItemModel( parent )
28 mReloadTimer.setInterval( 100 );
29 mReloadTimer.setSingleShot(
true );
30 connect( &mReloadTimer, &QTimer::timeout,
this, &QgsFeaturePickerModelBase::scheduledReload );
41 connect( mGatherer, &QgsFeatureExpressionValuesGatherer::finished, mGatherer, &QgsFeatureExpressionValuesGatherer::deleteLater );
104 return mFilterExpression;
125 if ( mFormFeature == feature )
128 mFormFeature = feature;
138 return mParentFormFeature;
143 if ( mParentFormFeature == feature )
146 mParentFormFeature = feature;
168 return createIndex( row, column,
nullptr );
175 return QModelIndex();
189 if ( !
index.isValid() )
194 case Qt::DisplayRole:
207 const QVariantList values =
mEntries.value(
index.row() ).identifierFields;
208 return values.value( 0 );
214 case Qt::BackgroundRole:
215 case Qt::ForegroundRole:
216 case Qt::DecorationRole:
223 if ( role == Qt::ForegroundRole )
225 return QBrush( QColor( Qt::gray ) );
227 if ( role == Qt::FontRole )
229 QFont font = QFont();
231 font.setBold(
true );
233 font.setItalic(
true );
248 if ( role == Qt::DecorationRole )
250 if ( role == Qt::FontRole )
262void QgsFeaturePickerModelBase::updateCompleter()
266 QgsFeatureExpressionValuesGatherer *gatherer = qobject_cast<QgsFeatureExpressionValuesGatherer *>( sender() );
267 if ( gatherer->wasCanceled() )
273 QVector<QgsFeatureExpressionValuesGatherer::Entry> entries = mGatherer->entries();
281 const bool reloadCurrentFeatureOnly = mGatherer->data().toBool();
282 if ( reloadCurrentFeatureOnly )
284 if ( !entries.isEmpty() )
288 mShouldReloadCurrentFeature =
false;
289 setExtraValueDoesNotExist(
false );
293 setExtraValueDoesNotExist(
true );
296 mKeepCurrentEntry =
true;
297 mShouldReloadCurrentFeature =
false;
299 if ( mFilterValue.isEmpty() )
305 std::sort( entries.begin(), entries.end(), [](
const QgsFeatureExpressionValuesGatherer::Entry & a,
const QgsFeatureExpressionValuesGatherer::Entry & b ) { return a.value.localeAwareCompare( b.value ) < 0; } );
307 if ( mAllowNull && mSourceLayer )
309 entries.prepend( QgsFeatureExpressionValuesGatherer::nullEntry( mSourceLayer ) );
312 const int newEntriesSize = entries.size();
315 const int nbFixedEntry = ( mKeepCurrentEntry ? 1 : 0 ) + ( mAllowNull ? 1 : 0 );
318 int currentEntryInNewList = -1;
321 for (
int i = 0; i < newEntriesSize; ++i )
326 currentEntryInNewList = i;
327 setExtraValueDoesNotExist(
false );
349 beginRemoveRows( QModelIndex(), firstRow,
mEntries.size() - firstRow );
355 mIsSettingExtraIdentifierValue =
true;
357 mIsSettingExtraIdentifierValue =
false;
359 if ( currentEntryInNewList == -1 )
361 beginInsertRows( QModelIndex(), firstRow, entries.size() + 1 );
368 setExtraIdentifierValueIndex( firstRow == 0 && mAllowNull && !entries.isEmpty() ? 1 : 0, firstRow == 0 );
372 if ( currentEntryInNewList != 0 )
374 beginInsertRows( QModelIndex(), 0, currentEntryInNewList - 1 );
380 mEntries.replace( 0, entries.at( 0 ) );
384 if ( currentEntryInNewList >= nbFixedEntry )
386 emit dataChanged(
index( currentEntryInNewList, 0, QModelIndex() ),
index( currentEntryInNewList, 0, QModelIndex() ) );
389 beginInsertRows( QModelIndex(), currentEntryInNewList + 1, newEntriesSize - currentEntryInNewList - 1 );
390 mEntries += entries.mid( currentEntryInNewList + 1 );
392 setExtraIdentifierValueIndex( currentEntryInNewList );
397 mKeepCurrentEntry =
false;
403 Q_ASSERT( gatherer == mGatherer );
410void QgsFeaturePickerModelBase::scheduledReload()
415 bool wasLoading =
false;
425 if ( mShouldReloadCurrentFeature )
431 QString filterClause;
433 if ( mFilterValue.isEmpty() && !mFilterExpression.isEmpty() )
434 filterClause = mFilterExpression;
435 else if ( mFilterExpression.isEmpty() && !mFilterValue.isEmpty() )
436 filterClause = QStringLiteral(
"(%1) ILIKE '%%2%'" ).arg( mDisplayExpression, mFilterValue );
437 else if ( !mFilterExpression.isEmpty() && !mFilterValue.isEmpty() )
438 filterClause = QStringLiteral(
"(%1) AND ((%2) ILIKE '%%3%')" ).arg( mFilterExpression, mDisplayExpression, mFilterValue );
440 if ( !filterClause.isEmpty() )
445 if ( !mFilterExpression.isEmpty() )
459 if ( !attributes.isEmpty() )
462 attributes += lFilterExpression->referencedColumns();
463 attributes += requestedAttributesForStyle();
468 if ( !mFetchGeometry )
470 if ( mFetchLimit > 0 )
474 mGatherer->setData( mShouldReloadCurrentFeature );
475 connect( mGatherer, &QgsFeatureExpressionValuesGatherer::finished,
this, &QgsFeaturePickerModelBase::updateCompleter );
483QSet<QString> QgsFeaturePickerModelBase::requestedAttributesForStyle()
const
485 QSet<QString> requestedAttrs;
492 requestedAttrs += exp.referencedColumns();
495 if ( mDisplayExpression.
isField() )
502 requestedAttrs += exp.referencedColumns();
506 return requestedAttrs;
510void QgsFeaturePickerModelBase::setExtraIdentifierValueIndex(
int index,
bool force )
520void QgsFeaturePickerModelBase::reloadCurrentFeature()
522 mShouldReloadCurrentFeature =
true;
523 mReloadTimer.start();
529 const QVector<QgsFeatureExpressionValuesGatherer::Entry> entries =
mEntries;
532 for (
const QgsFeatureExpressionValuesGatherer::Entry &entry : entries )
536 setExtraIdentifierValueIndex(
index );
547 if ( !isNull || mAllowNull )
549 beginInsertRows( QModelIndex(), 0, 0 );
553 setExtraValueDoesNotExist(
true );
554 reloadCurrentFeature();
558 mEntries.prepend( QgsFeatureExpressionValuesGatherer::nullEntry( mSourceLayer ) );
559 setExtraValueDoesNotExist(
false );
563 setExtraIdentifierValueIndex( 0,
true );
587 styles += matchingFieldStyles;
592 mEntryStylesMap.insert( fid, style );
617 return mFetchGeometry;
648 return mExtraValueDoesNotExist;
652void QgsFeaturePickerModelBase::setExtraValueDoesNotExist(
bool extraValueDoesNotExist )
668void QgsFeaturePickerModelBase::reload()
670 mReloadTimer.start();
679 if ( mIsSettingExtraIdentifierValue )
682 mIsSettingExtraIdentifierValue =
true;
688 mIsSettingExtraIdentifierValue =
false;
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
QgsConditionalStyles rowStyles() const
Returns a list of row styles associated with the layer.
QList< QgsConditionalStyle > fieldStyles(const QString &fieldName) const
Returns the conditional styles set for the field with matching fieldName.
Conditional styling for a rule.
static QgsConditionalStyle compressStyles(const QList< QgsConditionalStyle > &styles)
Compress a list of styles into a single style.
static QList< QgsConditionalStyle > matchingConditionalStyles(const QList< QgsConditionalStyle > &styles, const QVariant &value, QgsExpressionContext &context)
Find and return the matching styles for the value and feature.
QColor backgroundColor() const
The background color for style.
QColor textColor() const
The text color set for style.
QFont font() const
The font for the style.
bool validTextColor() const
Check if the text color is valid for render.
bool isValid() const
isValid Check if this rule is valid.
QPixmap icon() const
The icon set for style generated from the set symbol.
bool validBackgroundColor() const
Check if the background color is valid for render.
static QgsExpressionContextScope * parentFormScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current parent attribute form/tab...
static QgsExpressionContextScope * formScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current attribute form/table form...
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
void appendScopes(const QList< QgsExpressionContextScope * > &scopes)
Appends a list of scopes to the end of the context.
Handles parsing and evaluation of expressions (formerly called "search strings").
QString expression() const
Returns the original, unmodified expression string.
bool isField() const
Checks whether an expression consists only of a single field reference.
QSet< QString > referencedColumns() const
Gets list of columns referenced by the expression.
void extraIdentifierValueIndexChanged(int index)
The index at which the extra identifier value is available within the model.
void beginUpdate()
Notification that the model is about to be changed because a job was completed.
virtual QVariant entryIdentifier(const QgsFeatureExpressionValuesGatherer::Entry &entry) const =0
Returns the identifier of the given entry.
void filterValueChanged()
This value will be used to filter the features available from this model.
void setFilterValue(const QString &filterValue)
This value will be used to filter the features available from this model.
void setExtraIdentifierValue(const QVariant &extraIdentifierValue)
Allows specifying one value that does not need to match the filter criteria but will still be availab...
virtual void requestToReloadCurrentFeature(QgsFeatureRequest &request)=0
Update the request to match the current feature to be reloaded.
void setParentFormFeature(const QgsFeature &feature)
Sets a parent attribute form feature to be used with the filter expression.
void parentFormFeatureChanged()
A parent attribute form feature to be used alongside the filter expression.
void filterExpressionChanged()
An additional filter expression to apply, next to the filterValue.
void setFetchLimit(int fetchLimit)
Defines the feature request fetch limit If set to 0, no limit is applied when fetching.
QVariant extraIdentifierValue() const
Allows specifying one value that does not need to match the filter criteria but will still be availab...
void extraValueDoesNotExistChanged(bool found)
Notification whether the model has found a feature tied to the extraIdentifierValue or not.
QgsFeature formFeature() const
Returns an attribute form feature to be used with the filter expression.
virtual QgsFeatureExpressionValuesGatherer * createValuesGatherer(const QgsFeatureRequest &request) const =0
Creates the value gatherer.
void setFetchGeometry(bool fetchGeometry)
Defines if the geometry will be fetched.
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 d...
void extraIdentifierValueChanged()
Allows specifying one value that does not need to match the filter criteria but will still be availab...
virtual QSet< QString > requestedAttributes() const
Returns the attributes to be fetched in the request.
int mExtraValueIndex
The current index.
@ IdentifierValues
Used to retrieve the identifierValues (primary keys) of a feature.
@ FeatureId
Used to retrieve the id of a feature.
@ IdentifierValue
Used to retrieve the identifier value (primary key) of a feature.
@ Feature
Used to retrieve the feature, it might be incomplete if the request doesn't fetch all attributes or g...
@ Value
Used to retrieve the displayExpression of a feature.
QModelIndex parent(const QModelIndex &child) const override
void filterJobCompleted()
Indicates that a filter job has been completed and new data may be available.
void setAllowNull(bool allowNull)
Add a NULL entry to the list.
void setDisplayExpression(const QString &displayExpression)
The display expression will be used for.
QVariant mExtraIdentifierValue
The current identifier value.
QgsFeaturePickerModelBase(QObject *parent=nullptr)
Create a new QgsFeaturePickerModelBase, optionally specifying a parent.
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.
bool isLoading() const
Indicator if the model is currently performing any feature iteration in the background.
void setFormFeature(const QgsFeature &feature)
Sets an attribute form feature to be used with the filter expression.
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 identifi...
QgsVectorLayer * sourceLayer
QVariant data(const QModelIndex &index, int role) const override
QModelIndex index(int row, int column, const QModelIndex &parent) const override
int extraIdentifierValueIndex
void fetchLimitChanged()
Emitted when the fetching limit for the feature request changes.
void sourceLayerChanged()
The source layer from which features will be fetched.
QgsFeature parentFormFeature() const
Returns a parent attribute form feature to be used with the filter expression.
~QgsFeaturePickerModelBase() override
void setFilterExpression(const QString &filterExpression)
An additional filter expression to apply, next to the filterValue.
void allowNullChanged()
Add a NULL entry to the list.
int rowCount(const QModelIndex &parent) const override
virtual bool compareEntries(const QgsFeatureExpressionValuesGatherer::Entry &a, const QgsFeatureExpressionValuesGatherer::Entry &b) const =0
Returns true if the 2 entries refers to the same feature.
void currentFeatureChanged()
Emitted when the current feature in the model has changed This emitted both when the extra value chan...
void isLoadingChanged()
Indicator if the model is currently performing any feature iteration in the background.
void formFeatureChanged()
An attribute form feature to be used alongside the filter expression.
QString displayExpression
QVector< QgsFeatureExpressionValuesGatherer::Entry > mEntries
virtual QVariant nullIdentifier() const =0
Returns a null identifier.
void endUpdate()
Notification that the model change is finished.
void displayExpressionChanged()
The display expression will be used for.
void setSourceLayer(QgsVectorLayer *sourceLayer)
The source layer from which features will be fetched.
bool extraValueDoesNotExist() const
Flag indicating that the extraIdentifierValue does not exist in the data.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setLimit(long long limit)
Set the maximum number of features to request.
QgsExpressionContext * expressionContext()
Returns the expression context used to evaluate filter expressions.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsExpression * filterExpression() const
Returns the filter expression (if set).
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
bool isValid() const
Returns the validity of this feature.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Represents a vector layer which manages a vector based dataset.
QgsExpressionContext createExpressionContext() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QString displayExpression
QgsConditionalLayerStyles * conditionalStyles() const
Returns the conditional styles that are set for this layer.
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features