QGIS API Documentation  3.25.0-Master (6b426f5f8a)
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
6  email : m[email protected]
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  ***************************************************************************/
15 #include "qgsfeaturelistcombobox.h"
16 
17 #include "qgsfeaturefiltermodel.h"
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  mCompleter->setCaseSensitivity( Qt::CaseInsensitive );
33  mCompleter->setFilterMode( Qt::MatchContains );
34  setEditable( true );
35  setCompleter( mCompleter );
36  mCompleter->setWidget( this );
40  connect( mModel, &QgsFeatureFilterModel::isLoadingChanged, this, &QgsFeatureListComboBox::onLoadingChanged );
41  connect( mModel, &QgsFeatureFilterModel::filterJobCompleted, this, &QgsFeatureListComboBox::onFilterUpdateCompleted );
44  connect( mModel, &QgsFeatureFilterModel::extraIdentifierValueIndexChanged, this, &QgsFeatureListComboBox::setCurrentIndex );
46  connect( mCompleter, static_cast<void( QCompleter::* )( const QModelIndex & )>( &QCompleter::highlighted ), this, &QgsFeatureListComboBox::onItemSelected );
47  connect( mCompleter, static_cast<void( QCompleter::* )( const QModelIndex & )>( &QCompleter::activated ), this, &QgsFeatureListComboBox::onActivated );
48  connect( mModel, &QgsFeatureFilterModel::beginUpdate, this, &QgsFeatureListComboBox::storeLineEditState );
49  connect( mModel, &QgsFeatureFilterModel::endUpdate, this, &QgsFeatureListComboBox::restoreLineEditState );
51  connect( mModel, &QgsFeatureFilterModel::dataChanged, this, &QgsFeatureListComboBox::onDataChanged );
52 
53  connect( this, static_cast<void( QgsFeatureListComboBox::* )( int )>( &QgsFeatureListComboBox::currentIndexChanged ), this, &QgsFeatureListComboBox::onCurrentIndexChanged );
54 
55  mLineEdit = new QgsFilterLineEdit( nullptr, QgsApplication::nullRepresentation() );
56  mLineEdit->setSelectOnFocus( true );
57  mLineEdit->setShowClearButton( true );
58 
59  setLineEdit( mLineEdit );
60  setModel( mModel );
61 
62  connect( mLineEdit, &QgsFilterLineEdit::textEdited, this, &QgsFeatureListComboBox::onCurrentTextChanged );
63 
65 
66  setToolTip( tr( "Just start typing what you are looking for." ) );
67 }
68 
70 {
71  return mModel->sourceLayer();
72 }
73 
75 {
76  mModel->setSourceLayer( sourceLayer );
77 }
78 
80 {
81  QVariantList values;
82  const QStringList fields = mModel->identifierFields();
83  for ( const QString &field : fields )
84  {
85  values << feature.attribute( field );
86  }
87  setIdentifierValues( values );
88 }
89 
91 {
92  return mModel->displayExpression();
93 }
94 
95 void QgsFeatureListComboBox::setDisplayExpression( const QString &expression )
96 {
97  mModel->setDisplayExpression( expression );
98 }
99 
100 void QgsFeatureListComboBox::onCurrentTextChanged( const QString &text )
101 {
102  mIsCurrentlyEdited = true;
103  mPopupRequested = true;
104  mModel->setFilterValue( text );
105 }
106 
107 void QgsFeatureListComboBox::onFilterUpdateCompleted()
108 {
109  if ( mPopupRequested )
110  mCompleter->complete();
111 
112  mPopupRequested = false;
113 }
114 
115 void QgsFeatureListComboBox::onLoadingChanged()
116 {
117  mLineEdit->setShowSpinner( mModel->isLoading() );
118 }
119 
120 void QgsFeatureListComboBox::onItemSelected( const QModelIndex &index )
121 {
122  setCurrentIndex( index.row() );
123 }
124 
125 void QgsFeatureListComboBox::onCurrentIndexChanged( int i )
126 {
127  if ( !mLineEdit->hasStateStored() )
128  mIsCurrentlyEdited = false;
129  const QModelIndex modelIndex = mModel->index( i, 0, QModelIndex() );
130  mModel->setExtraIdentifierValues( mModel->data( modelIndex, QgsFeatureFilterModel::IdentifierValuesRole ).toList() );
131  mLineEdit->setText( mModel->data( modelIndex, QgsFeatureFilterModel::ValueRole ).toString() );
132  mLineEdit->setFont( mModel->data( modelIndex, Qt::FontRole ).value<QFont>() );
133  QPalette palette = mLineEdit->palette();
134  palette.setBrush( mLineEdit->foregroundRole(), mModel->data( modelIndex, Qt::ForegroundRole ).value<QBrush>() );
135  mLineEdit->setPalette( palette );
136 }
137 
138 void QgsFeatureListComboBox::onActivated( QModelIndex modelIndex )
139 {
140  setIdentifierValues( mModel->data( modelIndex, QgsFeatureFilterModel::IdentifierValuesRole ).toList() );
141  mLineEdit->setText( mModel->data( modelIndex, QgsFeatureFilterModel::ValueRole ).toString() );
142 }
143 
144 void QgsFeatureListComboBox::storeLineEditState()
145 {
146  if ( mIsCurrentlyEdited )
147  {
148  mLineEdit->storeState( );
149  }
150 }
151 
152 void QgsFeatureListComboBox::restoreLineEditState()
153 {
154  if ( mIsCurrentlyEdited )
155  {
156  mLineEdit->restoreState( );
157  }
158 }
159 
161 {
162  int index = -1;
163 
164  if ( allowNull() )
165  {
166  index = findText( QgsApplication::nullRepresentation( ) );
167  }
168 
169  return index;
170 }
171 
172 void QgsFeatureListComboBox::onDataChanged( const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles )
173 {
174  Q_UNUSED( roles )
175  if ( !mIsCurrentlyEdited )
176  {
177  const int currentIndex = mModel->extraIdentifierValueIndex();
178  if ( currentIndex >= topLeft.row() && currentIndex <= bottomRight.row() )
179  {
180  const QModelIndex modelIndex = mModel->index( currentIndex, 0, QModelIndex() );
181  mLineEdit->setText( mModel->data( modelIndex, QgsFeatureFilterModel::ValueRole ).toString() );
182  }
183  }
184 }
185 
187 {
188  const QStringList list = mModel->identifierFields();
189  if ( list.isEmpty() )
190  return QString();
191  else
192  return list.at( 0 );
193 }
194 
196 {
197  return mModel->identifierFields();
198 }
199 
200 void QgsFeatureListComboBox::setIdentifierField( const QString &identifierField )
201 {
202  mModel->setIdentifierFields( QStringList() << identifierField );
203 }
204 
205 void QgsFeatureListComboBox::setIdentifierFields( const QStringList &identifierFields )
206 {
208 }
209 
211 {
212  return mModel->index( mModel->extraIdentifierValueIndex(), 0, QModelIndex() );
213 }
214 
215 void QgsFeatureListComboBox::focusOutEvent( QFocusEvent *event )
216 {
217  Q_UNUSED( event )
218  QComboBox::focusOutEvent( event );
219  mLineEdit->setText( mModel->data( currentModelIndex(), QgsFeatureFilterModel::ValueRole ).toString() );
220 }
221 
223 {
224  if ( event->key() == Qt::Key_Escape )
225  {
226  mLineEdit->setText( mModel->data( currentModelIndex(), QgsFeatureFilterModel::ValueRole ).toString() );
227  }
228  QComboBox::keyReleaseEvent( event );
229 }
230 
232 {
233  return mModel->allowNull();
234 }
235 
237 {
238  mModel->setAllowNull( allowNull );
240 }
241 
243 {
245  return mModel->extraIdentifierValues().value( 0 );
247 }
248 
250 {
251  return mModel->extraIdentifierValues();
252 }
253 
254 void QgsFeatureListComboBox::setIdentifierValue( const QVariant &identifierValue )
255 {
256  setIdentifierValues( QVariantList() << identifierValue );
257 }
258 
259 void QgsFeatureListComboBox::setIdentifierValues( const QVariantList &identifierValues )
260 {
262 }
263 
265 {
267 }
268 
270 {
271  if ( mModel->extraIdentifierValues().isEmpty() )
272  {
273  return QgsFeatureRequest().setFilterFids( QgsFeatureIds() ); // NULL: Return a request that's guaranteed to not return anything
274  }
275  else
276  {
277  QStringList filtersAttrs;
278  const QStringList identifierFields = mModel->identifierFields();
279  const QVariantList values = mModel->extraIdentifierValues();
280  for ( int i = 0; i < identifierFields.count(); i++ )
281  {
282  if ( i >= values.count() )
283  {
284  filtersAttrs << QgsExpression::createFieldEqualityExpression( identifierFields.at( i ), QVariant() );
285  }
286  else
287  {
288  filtersAttrs << QgsExpression::createFieldEqualityExpression( identifierFields.at( i ), values.at( i ) );
289  }
290  }
291  const QString expression = filtersAttrs.join( QLatin1String( " AND " ) );
292  return QgsFeatureRequest().setFilterExpression( expression );
293  }
294 }
295 
297 {
298  return mModel->filterExpression();
299 }
300 
301 void QgsFeatureListComboBox::setFilterExpression( const QString &filterExpression )
302 {
304 }
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.
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 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 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.
Definition: qgsfeature.cpp:320
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:2533
#define Q_NOWARN_DEPRECATED_PUSH
Definition: qgis.h:2532
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:37
const QgsField & field
Definition: qgsfield.h:463