26 : QAbstractItemModel( parent )
28 mReloadTimer.setInterval( 100 );
29 mReloadTimer.setSingleShot(
true );
30 connect( &mReloadTimer, &QTimer::timeout,
this, &QgsFeaturePickerModelBase::scheduledReload );
42 connect( mGatherer, &QgsFeatureExpressionValuesGatherer::finished, mGatherer, &QgsFeatureExpressionValuesGatherer::deleteLater );
105 return mFilterExpression;
134 return createIndex( row, column,
nullptr );
141 return QModelIndex();
155 if ( !
index.isValid() )
160 case Qt::DisplayRole:
173 const QVariantList values =
mEntries.value(
index.row() ).identifierFields;
174 return values.value( 0 );
180 case Qt::BackgroundRole:
181 case Qt::ForegroundRole:
182 case Qt::DecorationRole:
189 if ( role == Qt::ForegroundRole )
191 return QBrush( QColor( Qt::gray ) );
193 if ( role == Qt::FontRole )
195 QFont font = QFont();
197 font.setBold(
true );
199 font.setItalic(
true );
214 if ( role == Qt::DecorationRole )
216 if ( role == Qt::FontRole )
228void QgsFeaturePickerModelBase::updateCompleter()
232 QgsFeatureExpressionValuesGatherer *gatherer = qobject_cast<QgsFeatureExpressionValuesGatherer *>( sender() );
233 if ( gatherer->wasCanceled() )
239 QVector<QgsFeatureExpressionValuesGatherer::Entry> entries = mGatherer->entries();
247 const bool reloadCurrentFeatureOnly = mGatherer->data().toBool();
248 if ( reloadCurrentFeatureOnly )
250 if ( !entries.isEmpty() )
254 mShouldReloadCurrentFeature =
false;
255 setExtraValueDoesNotExist(
false );
259 setExtraValueDoesNotExist(
true );
262 mKeepCurrentEntry =
true;
263 mShouldReloadCurrentFeature =
false;
265 if ( mFilterValue.isEmpty() )
271 std::sort( entries.begin(), entries.end(), [](
const QgsFeatureExpressionValuesGatherer::Entry & a,
const QgsFeatureExpressionValuesGatherer::Entry & b ) { return a.value.localeAwareCompare( b.value ) < 0; } );
273 if ( mAllowNull && mSourceLayer )
275 entries.prepend( QgsFeatureExpressionValuesGatherer::nullEntry( mSourceLayer ) );
278 const int newEntriesSize = entries.size();
281 const int nbFixedEntry = ( mKeepCurrentEntry ? 1 : 0 ) + ( mAllowNull ? 1 : 0 );
284 int currentEntryInNewList = -1;
287 for (
int i = 0; i < newEntriesSize; ++i )
292 currentEntryInNewList = i;
293 setExtraValueDoesNotExist(
false );
315 beginRemoveRows( QModelIndex(), firstRow,
mEntries.size() - firstRow );
321 mIsSettingExtraIdentifierValue =
true;
323 mIsSettingExtraIdentifierValue =
false;
325 if ( currentEntryInNewList == -1 )
327 beginInsertRows( QModelIndex(), firstRow, entries.size() + 1 );
334 setExtraIdentifierValueIndex( firstRow == 0 && mAllowNull && !entries.isEmpty() ? 1 : 0, firstRow == 0 );
338 if ( currentEntryInNewList != 0 )
340 beginInsertRows( QModelIndex(), 0, currentEntryInNewList - 1 );
346 mEntries.replace( 0, entries.at( 0 ) );
350 if ( currentEntryInNewList >= nbFixedEntry )
352 emit dataChanged(
index( currentEntryInNewList, 0, QModelIndex() ),
index( currentEntryInNewList, 0, QModelIndex() ) );
355 beginInsertRows( QModelIndex(), currentEntryInNewList + 1, newEntriesSize - currentEntryInNewList - 1 );
356 mEntries += entries.mid( currentEntryInNewList + 1 );
358 setExtraIdentifierValueIndex( currentEntryInNewList );
363 mKeepCurrentEntry =
false;
369 Q_ASSERT( gatherer == mGatherer );
376void QgsFeaturePickerModelBase::scheduledReload()
381 bool wasLoading =
false;
391 if ( mShouldReloadCurrentFeature )
397 QString filterClause;
399 if ( mFilterValue.isEmpty() && !mFilterExpression.isEmpty() )
400 filterClause = mFilterExpression;
401 else if ( mFilterExpression.isEmpty() && !mFilterValue.isEmpty() )
402 filterClause = QStringLiteral(
"(%1) ILIKE '%%2%'" ).arg( mDisplayExpression, mFilterValue );
403 else if ( !mFilterExpression.isEmpty() && !mFilterValue.isEmpty() )
404 filterClause = QStringLiteral(
"(%1) AND ((%2) ILIKE '%%3%')" ).arg( mFilterExpression, mDisplayExpression, mFilterValue );
406 if ( !filterClause.isEmpty() )
413 if ( !attributes.isEmpty() )
416 attributes += lFilterExpression->referencedColumns();
417 attributes += requestedAttributesForStyle();
422 if ( !mFetchGeometry )
424 if ( mFetchLimit > 0 )
428 mGatherer->setData( mShouldReloadCurrentFeature );
429 connect( mGatherer, &QgsFeatureExpressionValuesGatherer::finished,
this, &QgsFeaturePickerModelBase::updateCompleter );
437QSet<QString> QgsFeaturePickerModelBase::requestedAttributesForStyle()
const
439 QSet<QString> requestedAttrs;
446 requestedAttrs += exp.referencedColumns();
449 if ( mDisplayExpression.
isField() )
456 requestedAttrs += exp.referencedColumns();
460 return requestedAttrs;
464void QgsFeaturePickerModelBase::setExtraIdentifierValueIndex(
int index,
bool force )
474void QgsFeaturePickerModelBase::reloadCurrentFeature()
476 mShouldReloadCurrentFeature =
true;
477 mReloadTimer.start();
483 const QVector<QgsFeatureExpressionValuesGatherer::Entry> entries =
mEntries;
486 for (
const QgsFeatureExpressionValuesGatherer::Entry &entry : entries )
490 setExtraIdentifierValueIndex(
index );
501 if ( !isNull || mAllowNull )
503 beginInsertRows( QModelIndex(), 0, 0 );
507 setExtraValueDoesNotExist(
true );
508 reloadCurrentFeature();
512 mEntries.prepend( QgsFeatureExpressionValuesGatherer::nullEntry( mSourceLayer ) );
513 setExtraValueDoesNotExist(
false );
517 setExtraIdentifierValueIndex( 0,
true );
541 styles += matchingFieldStyles;
546 mEntryStylesMap.insert( fid, style );
571 return mFetchGeometry;
602 return mExtraValueDoesNotExist;
606void QgsFeaturePickerModelBase::setExtraValueDoesNotExist(
bool extraValueDoesNotExist )
622void QgsFeaturePickerModelBase::reload()
624 mReloadTimer.start();
633 if ( mIsSettingExtraIdentifierValue )
636 mIsSettingExtraIdentifierValue =
true;
642 mIsSettingExtraIdentifierValue =
false;
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 QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
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.
Class for 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 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...
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.
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.
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.
~QgsFeaturePickerModelBase() override
@ FeatureIdRole
Used to retrieve the id of a feature.
@ IdentifierValuesRole
Used to retrieve the identifierValues (primary keys) of a feature.
@ FeatureRole
Used to retrieve the feature, it might be incomplete if the request doesn't fetch all attributes or g...
@ ValueRole
Used to retrieve the displayExpression of a feature.
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.
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 extraValueDoesNotExistChanged()
Flag indicating that the extraIdentifierValue does not exist in the data.
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.
This class wraps a request for features to a vector layer (or directly its vector data provider).
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 & setFlags(QgsFeatureRequest::Flags flags)
Sets flags that affect how features will be fetched.
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.
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Represents a vector layer which manages a vector based data sets.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
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