18#include <nlohmann/json.hpp>
35#include <QStandardItemModel>
37#include <QStringListModel>
41#include "moc_qgsvaluerelationwidgetwrapper.cpp"
43using namespace Qt::StringLiterals;
45using namespace nlohmann;
48QgsFilteredTableWidget::QgsFilteredTableWidget( QWidget *parent,
bool showSearch,
bool displayGroupName )
50 , mDisplayGroupName( displayGroupName )
53 mSearchWidget->setShowSearchIcon(
true );
54 mSearchWidget->setShowClearButton(
true );
55 mTableWidget =
new QTableWidget(
this );
56 mTableWidget->horizontalHeader()->setSectionResizeMode( QHeaderView::Stretch );
57 mTableWidget->horizontalHeader()->setVisible(
false );
58 mTableWidget->verticalHeader()->setSectionResizeMode( QHeaderView::Stretch );
59 mTableWidget->verticalHeader()->setVisible(
false );
60 mTableWidget->setShowGrid(
false );
61 mTableWidget->setEditTriggers( QAbstractItemView::NoEditTriggers );
62 mTableWidget->setSelectionMode( QAbstractItemView::NoSelection );
63 mTableWidget->setContextMenuPolicy( Qt::CustomContextMenu );
65 QVBoxLayout *layout =
new QVBoxLayout();
66 layout->addWidget( mSearchWidget );
67 layout->addWidget( mTableWidget );
68 layout->setContentsMargins( 0, 0, 0, 0 );
69 layout->setSpacing( 0 );
72 mTableWidget->setFocusProxy( mSearchWidget );
73 connect( mSearchWidget, &QgsFilterLineEdit::textChanged,
this, &QgsFilteredTableWidget::filterStringChanged );
74 installEventFilter(
this );
78 mSearchWidget->setVisible(
false );
81 connect( mTableWidget, &QTableWidget::itemChanged,
this, &QgsFilteredTableWidget::itemChanged_p );
82 connect( mTableWidget, &QTableWidget::customContextMenuRequested,
this, &QgsFilteredTableWidget::onTableWidgetCustomContextMenuRequested );
85bool QgsFilteredTableWidget::eventFilter( QObject *watched, QEvent *event )
88 if ( event->type() == QEvent::KeyPress )
90 QKeyEvent *keyEvent =
static_cast<QKeyEvent *
>( event );
91 if ( keyEvent->key() == Qt::Key_Escape && !mSearchWidget->text().isEmpty() )
93 mSearchWidget->clear();
100void QgsFilteredTableWidget::filterStringChanged(
const QString &filterString )
102 auto signalBlockedTableWidget =
whileBlocking( mTableWidget );
103 Q_UNUSED( signalBlockedTableWidget )
105 mTableWidget->clearContents();
106 if ( !mCache.isEmpty() )
109 groups << QVariant();
110 for (
const QPair<QgsValueRelationFieldFormatter::ValueRelationItem, Qt::CheckState> &pair : std::as_const( mCache ) )
112 if ( !groups.contains( pair.first.group ) )
114 groups << pair.first.group;
117 const int groupsCount = mDisplayGroupName ? groups.count() : groups.count() - 1;
119 const int rCount = std::max( 1, (
int ) std::ceil( (
float ) ( mCache.count() + groupsCount ) / (
float ) mColumnCount ) );
120 mTableWidget->setRowCount( rCount );
124 QVariant currentGroup;
125 for (
const QPair<QgsValueRelationFieldFormatter::ValueRelationItem, Qt::CheckState> &pair : std::as_const( mCache ) )
127 if ( column == mColumnCount )
132 if ( currentGroup != pair.first.group )
134 currentGroup = pair.first.group;
135 if ( mDisplayGroupName || !( row == 0 && column == 0 ) )
137 QTableWidgetItem *item =
new QTableWidgetItem( mDisplayGroupName ? pair.first.group.toString() : QString() );
138 item->setFlags( item->flags() & ~Qt::ItemIsEnabled );
139 mTableWidget->setItem( row, column, item );
141 if ( column == mColumnCount )
148 if ( pair.first.value.contains( filterString, Qt::CaseInsensitive ) )
150 QTableWidgetItem *item =
new QTableWidgetItem( pair.first.value );
151 item->setData( Qt::UserRole, pair.first.key );
152 item->setData( Qt::ToolTipRole, pair.first.description );
153 item->setCheckState( pair.second );
154 item->setFlags( mEnabledTable ? item->flags() | Qt::ItemIsEnabled : item->flags() & ~Qt::ItemIsEnabled );
155 mTableWidget->setItem( row, column, item );
159 mTableWidget->setRowCount( row + 1 );
163QStringList QgsFilteredTableWidget::selection()
const
166 for (
const QPair<QgsValueRelationFieldFormatter::ValueRelationItem, Qt::CheckState> &pair : std::as_const( mCache ) )
168 if ( pair.second == Qt::Checked )
169 sel.append( pair.first.key.toString() );
174void QgsFilteredTableWidget::checkItems(
const QStringList &checked )
176 for ( QPair<QgsValueRelationFieldFormatter::ValueRelationItem, Qt::CheckState> &pair : mCache )
178 const bool isChecked = checked.contains( pair.first.key.toString() );
179 pair.second = isChecked ? Qt::Checked : Qt::Unchecked;
182 filterStringChanged( mSearchWidget->text() );
190 mCache.append( qMakePair( element, Qt::Unchecked ) );
192 filterStringChanged( mSearchWidget->text() );
195void QgsFilteredTableWidget::setIndeterminateState()
197 for (
int rowIndex = 0; rowIndex < mTableWidget->rowCount(); rowIndex++ )
199 for (
int columnIndex = 0; columnIndex < mColumnCount; ++columnIndex )
201 if ( item( rowIndex, columnIndex ) )
203 whileBlocking( mTableWidget )->item( rowIndex, columnIndex )->setCheckState( Qt::PartiallyChecked );
213void QgsFilteredTableWidget::setEnabledTable(
const bool enabled )
215 if ( mEnabledTable == enabled )
218 mEnabledTable = enabled;
220 mSearchWidget->clear();
222 filterStringChanged( mSearchWidget->text() );
225void QgsFilteredTableWidget::setColumnCount(
const int count )
227 mColumnCount = count;
228 mTableWidget->setColumnCount( count );
231void QgsFilteredTableWidget::itemChanged_p( QTableWidgetItem *item )
233 for ( QPair<QgsValueRelationFieldFormatter::ValueRelationItem, Qt::CheckState> &pair : mCache )
235 if ( pair.first.key == item->data( Qt::UserRole ) )
236 pair.second = item->checkState();
238 emit itemChanged( item );
241void QgsFilteredTableWidget::onTableWidgetCustomContextMenuRequested(
const QPoint &pos )
246 QAction *actionTableWidgetSelectAll =
new QAction( tr(
"Select All" ),
this );
247 QAction *actionTableWidgetDeselectAll =
new QAction( tr(
"Deselect All" ),
this );
248 connect( actionTableWidgetSelectAll, &QAction::triggered,
this, &QgsFilteredTableWidget::onTableWidgetMenuActionSelectAllTriggered );
249 connect( actionTableWidgetDeselectAll, &QAction::triggered,
this, &QgsFilteredTableWidget::onTableWidgetMenuActionDeselectAllTriggered );
251 QMenu *tableWidgetMenu =
new QMenu( mTableWidget );
252 tableWidgetMenu->addAction( actionTableWidgetSelectAll );
253 tableWidgetMenu->addAction( actionTableWidgetDeselectAll );
255 tableWidgetMenu->exec( QCursor::pos() );
258 disconnect( actionTableWidgetSelectAll, &QAction::triggered,
nullptr,
nullptr );
259 disconnect( actionTableWidgetDeselectAll, &QAction::triggered,
nullptr,
nullptr );
260 actionTableWidgetSelectAll->deleteLater();
261 actionTableWidgetDeselectAll->deleteLater();
264 tableWidgetMenu->deleteLater();
267void QgsFilteredTableWidget::onTableWidgetMenuActionSelectAllTriggered()
269 for (
int rowIndex = 0; rowIndex < mTableWidget->rowCount(); ++rowIndex )
271 for (
int columnIndex = 0; columnIndex < mTableWidget->columnCount(); ++columnIndex )
273 QTableWidgetItem *item =
whileBlocking( mTableWidget )->item( rowIndex, columnIndex );
274 if ( item && ( item->flags() & Qt::ItemIsEnabled ) )
276 item->setCheckState( Qt::Checked );
282void QgsFilteredTableWidget::onTableWidgetMenuActionDeselectAllTriggered()
284 for (
int rowIndex = 0; rowIndex < mTableWidget->rowCount(); ++rowIndex )
286 for (
int columnIndex = 0; columnIndex < mTableWidget->columnCount(); ++columnIndex )
288 QTableWidgetItem *item =
whileBlocking( mTableWidget )->item( rowIndex, columnIndex );
289 if ( item && ( item->flags() & Qt::ItemIsEnabled ) )
291 item->setCheckState( Qt::Unchecked );
309 int cbxIdx = mComboBox->currentIndex();
312 v = mComboBox->currentData();
317 else if ( mTableWidget )
319 QStringList selection = mTableWidget->selection();
322 if ( selection.isEmpty() && !
config( u
"AllowNull"_s ).toBool() )
329 for (
const QString &s : std::as_const( selection ) )
332 const QMetaType::Type type { fkType() };
335 case QMetaType::Type::Int:
336 vl.push_back( s.toInt() );
338 case QMetaType::Type::LongLong:
339 vl.push_back( s.toLongLong() );
347 if (
layer()->fields().at(
fieldIdx() ).type() == QMetaType::Type::QVariantMap ||
layer()->fields().at(
fieldIdx() ).type() == QMetaType::Type::QVariantList )
357 else if ( mLineEdit )
361 if ( item.value == mLineEdit->text() )
378 mExpression =
config().value( u
"FilterExpression"_s ).toString();
380 const bool allowMulti =
config( u
"AllowMulti"_s ).toBool();
381 const bool useCompleter =
config( u
"UseCompleter"_s ).toBool();
384 const bool displayGroupName =
config( u
"DisplayGroupName"_s ).toBool();
385 return new QgsFilteredTableWidget( parent, useCompleter, displayGroupName );
387 else if ( useCompleter )
394 combo->setMinimumContentsLength( 1 );
395 combo->setSizeAdjustPolicy( QComboBox::SizeAdjustPolicy::AdjustToMinimumContentsLengthWithIcon );
402 mComboBox = qobject_cast<QComboBox *>( editor );
403 mTableWidget = qobject_cast<QgsFilteredTableWidget *>( editor );
404 mLineEdit = qobject_cast<QLineEdit *>( editor );
411 mComboBox->view()->setVerticalScrollBarPolicy( Qt::ScrollBarAsNeeded );
414 else if ( mTableWidget )
418 else if ( mLineEdit )
420 if (
QgsFilterLineEdit *filterLineEdit = qobject_cast<QgsFilterLineEdit *>( editor ) )
423 if ( mSubWidgetSignalBlocking == 0 )
429 connect( mLineEdit, &QLineEdit::textChanged,
this, &QgsValueRelationWidgetWrapper::emitValueChangedInternal, Qt::UniqueConnection );
436 return mTableWidget || mLineEdit || mComboBox;
439void QgsValueRelationWidgetWrapper::updateValues(
const QVariant &value,
const QVariantList & )
441 updateValue(
value,
true );
444void QgsValueRelationWidgetWrapper::updateValue(
const QVariant &value,
bool forceComboInsertion )
448 QStringList checkList;
450 if (
layer()->fields().at(
fieldIdx() ).type() == QMetaType::Type::QVariantMap ||
layer()->fields().at(
fieldIdx() ).type() == QMetaType::Type::QVariantList )
452 checkList =
value.toStringList();
459 mTableWidget->checkItems( checkList );
461 else if ( mComboBox )
466 for (
int i = 0; i < mComboBox->count(); i++ )
468 QVariant v( mComboBox->itemData( i ) );
482 for (
int i = 0; i < mComboBox->count(); i++ )
490 mComboBox->setCurrentIndex( idx );
494 mComboBox->addItem(
value.toString().prepend(
'(' ).append(
')' ),
value );
495 mComboBox->setCurrentIndex( mComboBox->findData(
value ) );
500 mComboBox->setCurrentIndex( idx );
503 else if ( mLineEdit )
505 mSubWidgetSignalBlocking++;
507 bool wasFound {
false };
508 for (
const QgsValueRelationFieldFormatter::ValueRelationItem &i : std::as_const( mCache ) )
510 if ( i.key ==
value )
512 mLineEdit->setText( i.value );
520 mLineEdit->setText( tr(
"(no selection)" ) );
522 mSubWidgetSignalBlocking--;
532 if ( attributeChanged || isMultieditMode )
534 QVariant oldValue(
value() );
541 updateValue( isMultieditMode ? oldValue :
value(),
false );
556 QString attributeName( formFields.
names().at(
fieldIdx() ) );
587 QTimer::singleShot( 0,
this, [
this] {
588 if ( !mCache.isEmpty() )
596int QgsValueRelationWidgetWrapper::columnCount()
const
598 return std::max( 1,
config( u
"NofColumns"_s ).toInt() );
602QMetaType::Type QgsValueRelationWidgetWrapper::fkType()
const
607 QgsFields fields =
layer->fields();
611 return fields.
at( idx ).
type();
614 return QMetaType::Type::UnknownType;
617void QgsValueRelationWidgetWrapper::populate()
622 if (
context().parentFormFeature().isValid() )
631 else if ( mCache.empty() )
638 mComboBox->blockSignals(
true );
640 const bool allowNull =
config( u
"AllowNull"_s ).toBool();
646 if ( !mCache.isEmpty() )
648 QVariant currentGroup;
649 QStandardItemModel *model = qobject_cast<QStandardItemModel *>( mComboBox->model() );
650 const bool displayGroupName =
config( u
"DisplayGroupName"_s ).toBool();
651 for (
const QgsValueRelationFieldFormatter::ValueRelationItem &element : std::as_const( mCache ) )
653 if ( currentGroup != element.group )
655 if ( mComboBox->count() > ( allowNull ? 1 : 0 ) )
657 mComboBox->insertSeparator( mComboBox->count() );
659 if ( displayGroupName )
661 mComboBox->addItem( element.group.toString() );
662 QStandardItem *item = model->item( mComboBox->count() - 1 );
663 item->setFlags( item->flags() & ~Qt::ItemIsEnabled );
665 currentGroup = element.group;
668 mComboBox->addItem( element.value, element.key );
670 if ( !element.description.isEmpty() )
672 mComboBox->setItemData( mComboBox->count() - 1, element.description, Qt::ToolTipRole );
676 mComboBox->blockSignals(
false );
678 else if ( mTableWidget )
680 mTableWidget->setColumnCount( columnCount() );
681 mTableWidget->populate( mCache );
683 else if ( mLineEdit )
686 values.reserve( mCache.size() );
687 for (
const QgsValueRelationFieldFormatter::ValueRelationItem &i : std::as_const( mCache ) )
691 QStringListModel *m =
new QStringListModel( values, mLineEdit );
692 QCompleter *completer =
new QCompleter( m, mLineEdit );
694 const Qt::MatchFlags completerMatchFlags {
695 config().contains( u
"CompleterMatchFlags"_s ) ?
static_cast<Qt::MatchFlags
>(
config().value( u
"CompleterMatchFlags"_s, Qt::MatchFlag::MatchStartsWith ).toInt() ) : Qt::MatchFlag::MatchStartsWith
698 if ( completerMatchFlags.testFlag( Qt::MatchFlag::MatchContains ) )
700 completer->setFilterMode( Qt::MatchFlag::MatchContains );
704 completer->setFilterMode( Qt::MatchFlag::MatchStartsWith );
706 completer->setCaseSensitivity( Qt::CaseInsensitive );
707 mLineEdit->setCompleter( completer );
715 mTableWidget->setIndeterminateState();
717 else if ( mComboBox )
721 else if ( mLineEdit )
729 if ( mEnabled == enabled )
736 mTableWidget->setEnabledTable( enabled );
759void QgsValueRelationWidgetWrapper::emitValueChangedInternal(
const QString &
value )
Contains context information for attribute editor widgets.
QgsFeature parentFormFeature() const
Returns the feature of the currently edited parent form in its actual state.
void setParentFormFeature(const QgsFeature &feature)
Sets the feature of the currently edited parent form.
@ MultiEditMode
Multi edit mode, for editing fields of multiple features at once.
Mode attributeFormMode() const
Returns current attributeFormMode.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Q_INVOKABLE bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
bool isValid() const
Returns the validity of this feature.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Container of fields for a vector layer.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
QLineEdit subclass with built in support for clearing the widget's value and handling custom null val...
void valueChanged(const QString &value)
Same as textChanged() but with support for null values.
static QString buildArray(const QVariantList &list)
Build a postgres array like formatted list in a string from a QVariantList.
static QgsProject * instance()
Returns the QgsProject singleton instance.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
static QVariant createNullVariant(QMetaType::Type metaType)
Helper method to properly create a null QVariant from a metaType Returns the created QVariant.
Represents a vector layer which manages a vector based dataset.
bool qgsVariantEqual(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether they are equal, two NULL values are always treated a...
#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_PUSH
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.