QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
qgsfeaturelistcombobox.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsfeaturelistcombobox.cpp - QgsFeatureListComboBox
3 ---------------------
4 begin : 10.3.2017
5 copyright : (C) 2017 by Matthias Kuhn
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
16
18#include "qgsanimatedicon.h"
19#include "qgsfilterlineedit.h"
20#include "qgslogger.h"
21#include "qgsapplication.h"
22
23#include <QCompleter>
24#include <QLineEdit>
25#include <QKeyEvent>
26
28 : QComboBox( parent )
29 , mModel( new QgsFeatureFilterModel( this ) )
30 , mCompleter( new QCompleter( mModel ) )
31{
32 setMinimumContentsLength( 1 );
33 setSizeAdjustPolicy( QComboBox::SizeAdjustPolicy::AdjustToMinimumContentsLengthWithIcon );
34 mCompleter->setCaseSensitivity( Qt::CaseInsensitive );
35 mCompleter->setFilterMode( Qt::MatchContains );
36 setEditable( true );
37 setCompleter( mCompleter );
38 mCompleter->setWidget( this );
42 connect( mModel, &QgsFeatureFilterModel::isLoadingChanged, this, &QgsFeatureListComboBox::onLoadingChanged );
43 connect( mModel, &QgsFeatureFilterModel::filterJobCompleted, this, &QgsFeatureListComboBox::onFilterUpdateCompleted );
46 connect( mModel, &QgsFeatureFilterModel::extraIdentifierValueIndexChanged, this, &QgsFeatureListComboBox::setCurrentIndex );
48 connect( mCompleter, static_cast<void( QCompleter::* )( const QModelIndex & )>( &QCompleter::highlighted ), this, &QgsFeatureListComboBox::onItemSelected );
49 connect( mCompleter, static_cast<void( QCompleter::* )( const QModelIndex & )>( &QCompleter::activated ), this, &QgsFeatureListComboBox::onActivated );
50 connect( mModel, &QgsFeatureFilterModel::beginUpdate, this, &QgsFeatureListComboBox::storeLineEditState );
51 connect( mModel, &QgsFeatureFilterModel::endUpdate, this, &QgsFeatureListComboBox::restoreLineEditState );
53 connect( mModel, &QgsFeatureFilterModel::dataChanged, this, &QgsFeatureListComboBox::onDataChanged );
54
55 connect( this, static_cast<void( QgsFeatureListComboBox::* )( int )>( &QgsFeatureListComboBox::currentIndexChanged ), this, &QgsFeatureListComboBox::onCurrentIndexChanged );
56
57 mLineEdit = new QgsFilterLineEdit( nullptr, QgsApplication::nullRepresentation() );
58 mLineEdit->setSelectOnFocus( true );
59 mLineEdit->setShowClearButton( true );
60
61 setLineEdit( mLineEdit );
62 setModel( mModel );
63
64 connect( mLineEdit, &QgsFilterLineEdit::textEdited, this, &QgsFeatureListComboBox::onCurrentTextChanged );
65
67
68 setToolTip( tr( "Just start typing what you are looking for." ) );
69}
70
75
80
82{
83 QVariantList values;
84 const QStringList fields = mModel->identifierFields();
85 for ( const QString &field : fields )
86 {
87 values << feature.attribute( field );
88 }
89 setIdentifierValues( values );
90}
91
93{
94 return mModel->displayExpression();
95}
96
97void QgsFeatureListComboBox::setDisplayExpression( const QString &expression )
98{
99 mModel->setDisplayExpression( expression );
100}
101
102void QgsFeatureListComboBox::onCurrentTextChanged( const QString &text )
103{
104 mIsCurrentlyEdited = true;
105 mPopupRequested = true;
106 mModel->setFilterValue( text );
107}
108
109void QgsFeatureListComboBox::onFilterUpdateCompleted()
110{
111 if ( mPopupRequested )
112 mCompleter->complete();
113
114 mPopupRequested = false;
115}
116
117void QgsFeatureListComboBox::onLoadingChanged()
118{
119 mLineEdit->setShowSpinner( mModel->isLoading() );
120}
121
122void QgsFeatureListComboBox::onItemSelected( const QModelIndex &index )
123{
124 setCurrentIndex( index.row() );
125}
126
127void QgsFeatureListComboBox::onCurrentIndexChanged( int i )
128{
129 if ( !mLineEdit->hasStateStored() )
130 mIsCurrentlyEdited = false;
131 const QModelIndex modelIndex = mModel->index( i, 0, QModelIndex() );
132 mModel->setExtraIdentifierValues( mModel->data( modelIndex, QgsFeatureFilterModel::IdentifierValuesRole ).toList() );
133 mLineEdit->setText( mModel->data( modelIndex, QgsFeatureFilterModel::ValueRole ).toString() );
134 mLineEdit->setFont( mModel->data( modelIndex, Qt::FontRole ).value<QFont>() );
135 QPalette palette = mLineEdit->palette();
136 palette.setBrush( mLineEdit->foregroundRole(), mModel->data( modelIndex, Qt::ForegroundRole ).value<QBrush>() );
137 mLineEdit->setPalette( palette );
138}
139
140void QgsFeatureListComboBox::onActivated( QModelIndex modelIndex )
141{
143 mLineEdit->setText( mModel->data( modelIndex, QgsFeatureFilterModel::ValueRole ).toString() );
144}
145
146void QgsFeatureListComboBox::storeLineEditState()
147{
148 if ( mIsCurrentlyEdited )
149 {
150 mLineEdit->storeState( );
151 }
152}
153
154void QgsFeatureListComboBox::restoreLineEditState()
155{
156 if ( mIsCurrentlyEdited )
157 {
158 mLineEdit->restoreState( );
159 }
160}
161
163{
164 int index = -1;
165
166 if ( allowNull() )
167 {
168 index = findText( QgsApplication::nullRepresentation( ) );
169 }
170
171 return index;
172}
173
174void QgsFeatureListComboBox::onDataChanged( const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles )
175{
176 Q_UNUSED( roles )
177 if ( !mIsCurrentlyEdited )
178 {
179 const int currentIndex = mModel->extraIdentifierValueIndex();
180 if ( currentIndex >= topLeft.row() && currentIndex <= bottomRight.row() )
181 {
182 const QModelIndex modelIndex = mModel->index( currentIndex, 0, QModelIndex() );
183 mLineEdit->setText( mModel->data( modelIndex, QgsFeatureFilterModel::ValueRole ).toString() );
184 }
185 }
186}
187
189{
190 const QStringList list = mModel->identifierFields();
191 if ( list.isEmpty() )
192 return QString();
193 else
194 return list.at( 0 );
195}
196
198{
199 return mModel->identifierFields();
200}
201
202void QgsFeatureListComboBox::setIdentifierField( const QString &identifierField )
203{
204 mModel->setIdentifierFields( QStringList() << identifierField );
205}
206
207void QgsFeatureListComboBox::setIdentifierFields( const QStringList &identifierFields )
208{
210}
211
213{
214 return mModel->index( currentIndex(), 0, QModelIndex() );
215}
216
218{
219 Q_UNUSED( event )
220 QComboBox::focusOutEvent( event );
221 mLineEdit->setText( mModel->data( currentModelIndex(), QgsFeatureFilterModel::ValueRole ).toString() );
222}
223
225{
226 if ( event->key() == Qt::Key_Escape )
227 {
228 mLineEdit->setText( mModel->data( currentModelIndex(), QgsFeatureFilterModel::ValueRole ).toString() );
229 }
230 QComboBox::keyReleaseEvent( event );
231}
232
234{
235 return mModel->allowNull();
236}
237
243
245{
246 return mModel->fetchLimit();
247}
248
250{
251 mModel->setFetchLimit( fetchLimit );
252}
253
260
262{
263 return mModel->extraIdentifierValues();
264}
265
266void QgsFeatureListComboBox::setIdentifierValue( const QVariant &identifierValue )
267{
268 setIdentifierValues( QVariantList() << identifierValue );
269}
270
271void QgsFeatureListComboBox::setIdentifierValues( const QVariantList &identifierValues )
272{
274}
275
280
282{
283 if ( mModel->extraIdentifierValues().isEmpty() )
284 {
285 return QgsFeatureRequest().setFilterFids( QgsFeatureIds() ); // NULL: Return a request that's guaranteed to not return anything
286 }
287 else
288 {
289 QStringList filtersAttrs;
290 const QStringList identifierFields = mModel->identifierFields();
291 const QVariantList values = mModel->extraIdentifierValues();
292 for ( int i = 0; i < identifierFields.count(); i++ )
293 {
294 if ( i >= values.count() )
295 {
296 filtersAttrs << QgsExpression::createFieldEqualityExpression( identifierFields.at( i ), QVariant() );
297 }
298 else
299 {
300 filtersAttrs << QgsExpression::createFieldEqualityExpression( identifierFields.at( i ), values.at( i ) );
301 }
302 }
303 const QString expression = filtersAttrs.join( QLatin1String( " AND " ) );
304 return QgsFeatureRequest().setFilterExpression( expression );
305 }
306}
307
309{
310 return mModel->filterExpression();
311}
312
313void QgsFeatureListComboBox::setFilterExpression( const QString &filterExpression )
314{
316}
static QString nullRepresentation()
This string is used to represent the value NULL throughout QGIS.
static QString createFieldEqualityExpression(const QString &fieldName, const QVariant &value, QVariant::Type fieldType=QVariant::Type::Invalid)
Create an expression allowing to evaluate if a field is equal to a value.
Provides a list of features based on filter conditions.
void setExtraIdentifierValues(const QVariantList &extraIdentifierValues)
Allows specifying one value that does not need to match the filter criteria but will still be availab...
void setExtraIdentifierValueToNull() override
Allows specifying one value that does not need to match the filter criteria but will still be availab...
QStringList identifierFields
A set of fields of sourceLayer that is unique and should be used to identify features.
QVariantList extraIdentifierValues
The values that identifies the current feature.
void identifierFieldsChanged()
The identifier field should be a unique field that can be used to identify individual features.
void setIdentifierFields(const QStringList &identifierFields)
The identifier field should be a unique field that can be used to identify individual features.
This offers a combobox with autocompleter that allows selecting features from a layer.
void setIdentifierValues(const QVariantList &identifierValues)
The identifier values of the currently selected feature.
void keyPressEvent(QKeyEvent *event) override
Q_DECL_DEPRECATED void setIdentifierField(const QString &identifierField)
Field name that will be used to uniquely identify the current feature.
void setDisplayExpression(const QString &displayExpression)
The display expression will be used to display features as well as the value to match the typed text ...
QModelIndex currentModelIndex() const
The index of the currently selected item.
void setFilterExpression(const QString &filterExpression)
An additional expression to further restrict the available features.
void setIdentifierFields(const QStringList &identifierFields)
Field name that will be used to uniquely identify the current feature.
void allowNullChanged()
Determines if a NULL value should be available in the list.
QgsFeatureListComboBox(QWidget *parent=nullptr)
Create a new QgsFeatureListComboBox, optionally specifying a parent.
void focusOutEvent(QFocusEvent *event) override
void setSourceLayer(QgsVectorLayer *sourceLayer)
The layer from which features should be listed.
void modelUpdated()
The underlying model has been updated.
QgsFeatureRequest currentFeatureRequest() const
Shorthand for getting a feature request to query the currently selected feature.
void setIdentifierValuesToNull()
Sets the identifier values of the currently selected feature to NULL value(s).
void identifierValueChanged()
The identifier value of the currently selected feature.
void sourceLayerChanged()
The layer from which features should be listed.
void setCurrentFeature(const QgsFeature &feature)
Sets the current index by using the given feature.
int nullIndex() const
Returns the current index of the NULL value, or -1 if NULL values are not allowed.
int fetchLimit() const
Returns the feature request fetch limit.
Q_DECL_DEPRECATED void setIdentifierValue(const QVariant &identifierValue)
The identifier value of the currently selected feature.
void currentFeatureChanged()
Emitted when the current feature changes.
QStringList identifierFields() const
Field name that will be used to uniquely identify the current feature.
void setAllowNull(bool allowNull)
Determines if a NULL value should be available in the list.
void displayExpressionChanged()
The display expression will be used to display features as well as the the value to match the typed t...
void identifierFieldChanged()
Field name that will be used to uniquely identify the current feature.
void setFetchLimit(int fetchLimit)
Defines the feature request fetch limit If set to 0, no limit is applied when fetching.
void filterExpressionChanged()
An additional expression to further restrict the available features.
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.
void setFilterValue(const QString &filterValue)
This value will be used to filter the features available from this model.
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.
void extraIdentifierValueChanged()
Allows specifying one value that does not need to match the filter criteria but will still be availab...
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.
bool isLoading() const
Indicator if the model is currently performing any feature iteration in the background.
QVariant data(const QModelIndex &index, int role) const override
QModelIndex index(int row, int column, const QModelIndex &parent) const override
void sourceLayerChanged()
The source layer from which features will be fetched.
@ IdentifierValuesRole
Used to retrieve the identifierValues (primary keys) of a feature.
@ 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.
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 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.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFilterFids(const QgsFeatureIds &fids)
Sets the feature IDs that should be fetched.
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...
Definition qgsfeature.h:56
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
QLineEdit subclass with built in support for clearing the widget's value and handling custom null val...
void restoreState()
Restores the current state of the line edit (selection and cursor position)
void storeState()
Stores the current state of the line edit (selection and cursor position)
@ ClearToNull
Reset value to null.
@ ClearToDefault
Reset value to default value (see defaultValue() )
void setShowClearButton(bool visible)
Sets whether the widget's clear button is visible.
bool hasStateStored() const
Returns if a state is already saved.
void setSelectOnFocus(bool selectOnFocus)
Will select all text when this widget receives the focus.
void setShowSpinner(bool showSpinner)
Show a spinner icon.
void setClearMode(ClearMode mode)
Sets the clear mode for the widget.
Represents a vector layer which manages a vector based data sets.
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:4916
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:4915
QSet< QgsFeatureId > QgsFeatureIds