24 : QAbstractItemModel( parent )
26 mReloadTimer.setInterval( 100 );
27 mReloadTimer.setSingleShot(
true );
28 connect( &mReloadTimer, &QTimer::timeout,
this, &QgsFeaturePickerModelBase::scheduledReload );
39 connect( mGatherer, &QgsFeatureExpressionValuesGatherer::finished, mGatherer, &QgsFeatureExpressionValuesGatherer::deleteLater );
102 return mFilterExpression;
131 return createIndex( row, column,
nullptr );
138 return QModelIndex();
152 if ( !
index.isValid() )
157 case Qt::DisplayRole:
170 const QVariantList values =
mEntries.value(
index.row() ).identifierFields;
171 return values.value( 0 );
177 case Qt::BackgroundRole:
178 case Qt::ForegroundRole:
179 case Qt::DecorationRole:
186 if ( role == Qt::ForegroundRole )
188 return QBrush( QColor( Qt::gray ) );
190 if ( role == Qt::FontRole )
192 QFont font = QFont();
194 font.setBold(
true );
196 font.setItalic(
true );
211 if ( role == Qt::DecorationRole )
213 if ( role == Qt::FontRole )
225void QgsFeaturePickerModelBase::updateCompleter()
229 QgsFeatureExpressionValuesGatherer *gatherer = qobject_cast<QgsFeatureExpressionValuesGatherer *>( sender() );
230 if ( gatherer->wasCanceled() )
236 QVector<QgsFeatureExpressionValuesGatherer::Entry> entries = mGatherer->entries();
244 const bool reloadCurrentFeatureOnly = mGatherer->data().toBool();
245 if ( reloadCurrentFeatureOnly )
247 if ( !entries.isEmpty() )
251 mShouldReloadCurrentFeature =
false;
252 setExtraValueDoesNotExist(
false );
256 setExtraValueDoesNotExist(
true );
259 mKeepCurrentEntry =
true;
260 mShouldReloadCurrentFeature =
false;
262 if ( mFilterValue.isEmpty() )
268 std::sort( entries.begin(), entries.end(), [](
const QgsFeatureExpressionValuesGatherer::Entry & a,
const QgsFeatureExpressionValuesGatherer::Entry & b ) { return a.value.localeAwareCompare( b.value ) < 0; } );
270 if ( mAllowNull && mSourceLayer )
272 entries.prepend( QgsFeatureExpressionValuesGatherer::nullEntry( mSourceLayer ) );
275 const int newEntriesSize = entries.size();
278 const int nbFixedEntry = ( mKeepCurrentEntry ? 1 : 0 ) + ( mAllowNull ? 1 : 0 );
281 int currentEntryInNewList = -1;
284 for (
int i = 0; i < newEntriesSize; ++i )
289 currentEntryInNewList = i;
290 setExtraValueDoesNotExist(
false );
312 beginRemoveRows( QModelIndex(), firstRow,
mEntries.size() - firstRow );
318 mIsSettingExtraIdentifierValue =
true;
320 mIsSettingExtraIdentifierValue =
false;
322 if ( currentEntryInNewList == -1 )
324 beginInsertRows( QModelIndex(), firstRow, entries.size() + 1 );
331 setExtraIdentifierValueIndex( firstRow == 0 && mAllowNull && !entries.isEmpty() ? 1 : 0, firstRow == 0 );
335 if ( currentEntryInNewList != 0 )
337 beginInsertRows( QModelIndex(), 0, currentEntryInNewList - 1 );
343 mEntries.replace( 0, entries.at( 0 ) );
347 if ( currentEntryInNewList >= nbFixedEntry )
349 emit dataChanged(
index( currentEntryInNewList, 0, QModelIndex() ),
index( currentEntryInNewList, 0, QModelIndex() ) );
352 beginInsertRows( QModelIndex(), currentEntryInNewList + 1, newEntriesSize - currentEntryInNewList - 1 );
353 mEntries += entries.mid( currentEntryInNewList + 1 );
355 setExtraIdentifierValueIndex( currentEntryInNewList );
360 mKeepCurrentEntry =
false;
366 Q_ASSERT( gatherer == mGatherer );
373void QgsFeaturePickerModelBase::scheduledReload()
378 bool wasLoading =
false;
388 if ( mShouldReloadCurrentFeature )
394 QString filterClause;
396 if ( mFilterValue.isEmpty() && !mFilterExpression.isEmpty() )
397 filterClause = mFilterExpression;
398 else if ( mFilterExpression.isEmpty() && !mFilterValue.isEmpty() )
399 filterClause = QStringLiteral(
"(%1) ILIKE '%%2%'" ).arg( mDisplayExpression, mFilterValue );
400 else if ( !mFilterExpression.isEmpty() && !mFilterValue.isEmpty() )
401 filterClause = QStringLiteral(
"(%1) AND ((%2) ILIKE '%%3%')" ).arg( mFilterExpression, mDisplayExpression, mFilterValue );
403 if ( !filterClause.isEmpty() )
410 if ( !attributes.isEmpty() )
413 attributes += lFilterExpression->referencedColumns();
414 attributes += requestedAttributesForStyle();
419 if ( !mFetchGeometry )
421 if ( mFetchLimit > 0 )
425 mGatherer->setData( mShouldReloadCurrentFeature );
426 connect( mGatherer, &QgsFeatureExpressionValuesGatherer::finished,
this, &QgsFeaturePickerModelBase::updateCompleter );
434QSet<QString> QgsFeaturePickerModelBase::requestedAttributesForStyle()
const
436 QSet<QString> requestedAttrs;
443 requestedAttrs += exp.referencedColumns();
446 if ( mDisplayExpression.
isField() )
453 requestedAttrs += exp.referencedColumns();
457 return requestedAttrs;
461void QgsFeaturePickerModelBase::setExtraIdentifierValueIndex(
int index,
bool force )
471void QgsFeaturePickerModelBase::reloadCurrentFeature()
473 mShouldReloadCurrentFeature =
true;
474 mReloadTimer.start();
480 const QVector<QgsFeatureExpressionValuesGatherer::Entry> entries =
mEntries;
483 for (
const QgsFeatureExpressionValuesGatherer::Entry &entry : entries )
487 setExtraIdentifierValueIndex(
index );
498 if ( !isNull || mAllowNull )
500 beginInsertRows( QModelIndex(), 0, 0 );
504 setExtraValueDoesNotExist(
true );
505 reloadCurrentFeature();
509 mEntries.prepend( QgsFeatureExpressionValuesGatherer::nullEntry( mSourceLayer ) );
510 setExtraValueDoesNotExist(
false );
514 setExtraIdentifierValueIndex( 0,
true );
538 styles += matchingFieldStyles;
543 mEntryStylesMap.insert( fid, style );
568 return mFetchGeometry;
599 return mExtraValueDoesNotExist;
603void QgsFeaturePickerModelBase::setExtraValueDoesNotExist(
bool extraValueDoesNotExist )
619void QgsFeaturePickerModelBase::reload()
621 mReloadTimer.start();
630 if ( mIsSettingExtraIdentifierValue )
633 mIsSettingExtraIdentifierValue =
true;
639 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 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...
void extraValueDoesNotExistChanged(bool found)
Notification whether the model has found a feature tied to the extraIdentifierValue or not.
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.
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
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 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 & 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...
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Represents a vector layer which manages a vector based data sets.
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