QGIS API Documentation 3.41.0-Master (181b2f43d8e)
Loading...
Searching...
No Matches
qgsrelationreferenceconfigdlg.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsrelationreferenceconfigdlg.cpp
3 --------------------------------------
4 Date : 21.4.2013
5 Copyright : (C) 2013 Matthias Kuhn
6 Email : matthias at opengis dot ch
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
17#include "moc_qgsrelationreferenceconfigdlg.cpp"
18
19#include "qgsfields.h"
20#include "qgsproject.h"
21#include "qgsrelationmanager.h"
22#include "qgsvectorlayer.h"
25#include "qgsfieldconstraints.h"
26
28 : QgsEditorConfigWidget( vl, fieldIdx, parent )
29
30{
31 setupUi( this );
32
33 mFetchLimit->setMaximum( std::numeric_limits<int>::max() );
34
35 connect( mAddFilterButton, &QToolButton::clicked, this, &QgsRelationReferenceConfigDlg::mAddFilterButton_clicked );
36 connect( mRemoveFilterButton, &QToolButton::clicked, this, &QgsRelationReferenceConfigDlg::mRemoveFilterButton_clicked );
37
38 mExpressionWidget->registerExpressionContextGenerator( vl );
39
40 connect( mComboRelation, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsRelationReferenceConfigDlg::relationChanged );
41
42 const auto constReferencingRelations = vl->referencingRelations( fieldIdx );
43 for ( const QgsRelation &relation : constReferencingRelations )
44 {
45 if ( relation.name().isEmpty() )
46 mComboRelation->addItem( QStringLiteral( "%1 (%2)" ).arg( relation.id(), relation.referencedLayerId() ), relation.id() );
47 else
48 mComboRelation->addItem( QStringLiteral( "%1 (%2)" ).arg( relation.name(), relation.referencedLayerId() ), relation.id() );
49
50 QStandardItemModel *model = qobject_cast<QStandardItemModel *>( mComboRelation->model() );
51 QStandardItem *item = model->item( model->rowCount() - 1 );
52 item->setFlags( relation.type() == Qgis::RelationshipType::Generated
53 ? item->flags() & ~Qt::ItemIsEnabled
54 : item->flags() | Qt::ItemIsEnabled );
55
56 if ( auto *lReferencedLayer = relation.referencedLayer() )
57 {
58 mExpressionWidget->setField( lReferencedLayer->displayExpression() );
59 }
60 }
61
62 connect( mCbxAllowNull, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
63 connect( mCbxShowForm, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
64 connect( mCbxShowOpenFormButton, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
65 connect( mCbxMapIdentification, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
66 connect( mCbxReadOnly, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
67 connect( mComboRelation, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsEditorConfigWidget::changed );
68 connect( mCbxAllowAddFeatures, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
69 connect( mFilterGroupBox, &QGroupBox::toggled, this, &QgsEditorConfigWidget::changed );
70 connect( mFilterFieldsList, &QListWidget::itemChanged, this, &QgsEditorConfigWidget::changed );
71 connect( mCbxChainFilters, &QAbstractButton::toggled, this, &QgsEditorConfigWidget::changed );
72 connect( mExpressionWidget, static_cast<void ( QgsFieldExpressionWidget::* )( const QString & )>( &QgsFieldExpressionWidget::fieldChanged ), this, &QgsEditorConfigWidget::changed );
73 connect( mEditExpression, &QAbstractButton::clicked, this, &QgsRelationReferenceConfigDlg::mEditExpression_clicked );
74 connect( mFilterExpression, &QTextEdit::textChanged, this, &QgsEditorConfigWidget::changed );
75 connect( mFetchLimitCheckBox, &QCheckBox::toggled, mFetchLimit, &QSpinBox::setEnabled );
76}
77
78void QgsRelationReferenceConfigDlg::mEditExpression_clicked()
79{
80 QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer() );
81 if ( !vl )
82 return;
83
87
88 context.setHighlightedFunctions( QStringList() << QStringLiteral( "current_value" ) << QStringLiteral( "current_parent_value" ) );
89 context.setHighlightedVariables( QStringList() << QStringLiteral( "current_geometry" )
90 << QStringLiteral( "current_feature" )
91 << QStringLiteral( "form_mode" )
92 << QStringLiteral( "current_parent_geometry" )
93 << QStringLiteral( "current_parent_feature" ) );
94
95 QgsExpressionBuilderDialog dlg( vl, mFilterExpression->toPlainText(), this, QStringLiteral( "generic" ), context );
96 dlg.setWindowTitle( tr( "Edit Filter Expression" ) );
97
98 if ( dlg.exec() == QDialog::Accepted )
99 {
100 mFilterExpression->setPlainText( dlg.expressionBuilder()->expressionText() );
101 }
102}
103
104void QgsRelationReferenceConfigDlg::setConfig( const QVariantMap &config )
105{
106 // Only unset allowNull if it was in the config or the default value that was
107 // calculated from the field constraints when the widget was created will be overridden
108 mAllowNullWasSetByConfig = config.contains( QStringLiteral( "AllowNULL" ) );
109 if ( mAllowNullWasSetByConfig )
110 {
111 mCbxAllowNull->setChecked( config.value( QStringLiteral( "AllowNULL" ), false ).toBool() );
112 }
113 mCbxShowForm->setChecked( config.value( QStringLiteral( "ShowForm" ), false ).toBool() );
114 mCbxShowOpenFormButton->setChecked( config.value( QStringLiteral( "ShowOpenFormButton" ), true ).toBool() );
115
116 if ( config.contains( QStringLiteral( "Relation" ) ) )
117 {
118 mComboRelation->setCurrentIndex( mComboRelation->findData( config.value( QStringLiteral( "Relation" ) ).toString() ) );
119 relationChanged( mComboRelation->currentIndex() );
120 }
121
122 mCbxMapIdentification->setChecked( config.value( QStringLiteral( "MapIdentification" ), false ).toBool() );
123 mCbxAllowAddFeatures->setChecked( config.value( QStringLiteral( "AllowAddFeatures" ), false ).toBool() );
124 mCbxReadOnly->setChecked( config.value( QStringLiteral( "ReadOnly" ), false ).toBool() );
125 mFetchLimitCheckBox->setChecked( config.value( QStringLiteral( "FetchLimitActive" ), QgsSettings().value( QStringLiteral( "maxEntriesRelationWidget" ), 100, QgsSettings::Gui ).toInt() > 0 ).toBool() );
126 mFetchLimit->setValue( config.value( QStringLiteral( "FetchLimitNumber" ), QgsSettings().value( QStringLiteral( "maxEntriesRelationWidget" ), 100, QgsSettings::Gui ) ).toInt() );
127 mFilterExpression->setPlainText( config.value( QStringLiteral( "FilterExpression" ) ).toString() );
128
129 if ( config.contains( QStringLiteral( "FilterFields" ) ) )
130 {
131 mFilterGroupBox->setChecked( true );
132 const auto constToStringList = config.value( "FilterFields" ).toStringList();
133 for ( const QString &fld : constToStringList )
134 {
135 addFilterField( fld );
136 }
137
138 mCbxChainFilters->setChecked( config.value( QStringLiteral( "ChainFilters" ) ).toBool() );
139 }
140}
141
142void QgsRelationReferenceConfigDlg::relationChanged( int idx )
143{
144 const QString relName = mComboRelation->itemData( idx ).toString();
145 const QgsRelation rel = QgsProject::instance()->relationManager()->relation( relName );
146
147 mReferencedLayer = rel.referencedLayer();
148 mExpressionWidget->setLayer( mReferencedLayer ); // set even if 0
149 if ( mReferencedLayer )
150 {
151 mExpressionWidget->setField( mReferencedLayer->displayExpression() );
152 mCbxMapIdentification->setEnabled( mReferencedLayer->isSpatial() );
153 }
154
155 // If AllowNULL is not set in the config, provide a default value based on the
156 // constraints of the referencing fields
157 if ( ! mAllowNullWasSetByConfig )
158 {
159 mCbxAllowNull->setChecked( rel.referencingFieldsAllowNull() );
160 }
161
162 loadFields();
163}
164
165void QgsRelationReferenceConfigDlg::mAddFilterButton_clicked()
166{
167 const auto constSelectedItems = mAvailableFieldsList->selectedItems();
168 for ( QListWidgetItem *item : constSelectedItems )
169 {
170 addFilterField( item );
171 }
172}
173
174void QgsRelationReferenceConfigDlg::mRemoveFilterButton_clicked()
175{
176 const auto constSelectedItems = mFilterFieldsList->selectedItems();
177 for ( QListWidgetItem *item : constSelectedItems )
178 {
179 mFilterFieldsList->takeItem( indexFromListWidgetItem( item ) );
180 mAvailableFieldsList->addItem( item );
181 }
182}
183
185{
186 QVariantMap myConfig;
187 myConfig.insert( QStringLiteral( "AllowNULL" ), mCbxAllowNull->isChecked() );
188 myConfig.insert( QStringLiteral( "ShowForm" ), mCbxShowForm->isChecked() );
189 myConfig.insert( QStringLiteral( "ShowOpenFormButton" ), mCbxShowOpenFormButton->isChecked() );
190 myConfig.insert( QStringLiteral( "MapIdentification" ), mCbxMapIdentification->isEnabled() && mCbxMapIdentification->isChecked() );
191 myConfig.insert( QStringLiteral( "ReadOnly" ), mCbxReadOnly->isChecked() );
192 myConfig.insert( QStringLiteral( "Relation" ), mComboRelation->currentData() );
193 myConfig.insert( QStringLiteral( "AllowAddFeatures" ), mCbxAllowAddFeatures->isChecked() );
194 myConfig.insert( QStringLiteral( "FetchLimitActive" ), mFetchLimitCheckBox->isChecked() );
195 myConfig.insert( QStringLiteral( "FetchLimitNumber" ), mFetchLimit->value() );
196
197 if ( mFilterGroupBox->isChecked() )
198 {
199 QStringList filterFields;
200 filterFields.reserve( mFilterFieldsList->count() );
201 for ( int i = 0; i < mFilterFieldsList->count(); i++ )
202 {
203 filterFields << mFilterFieldsList->item( i )->data( Qt::UserRole ).toString();
204 }
205 myConfig.insert( QStringLiteral( "FilterFields" ), filterFields );
206
207 myConfig.insert( QStringLiteral( "ChainFilters" ), mCbxChainFilters->isChecked() );
208 myConfig.insert( QStringLiteral( "FilterExpression" ), mFilterExpression->toPlainText() );
209 }
210
211 if ( mReferencedLayer )
212 {
213 // Store referenced layer data source and provider
214 myConfig.insert( QStringLiteral( "ReferencedLayerDataSource" ), mReferencedLayer->publicSource() );
215 myConfig.insert( QStringLiteral( "ReferencedLayerProviderKey" ), mReferencedLayer->providerType() );
216 myConfig.insert( QStringLiteral( "ReferencedLayerId" ), mReferencedLayer->id() );
217 myConfig.insert( QStringLiteral( "ReferencedLayerName" ), mReferencedLayer->name() );
218 mReferencedLayer->setDisplayExpression( mExpressionWidget->currentField() );
219 }
220
221 return myConfig;
222}
223
224void QgsRelationReferenceConfigDlg::loadFields()
225{
226 mAvailableFieldsList->clear();
227 mFilterFieldsList->clear();
228
229 if ( mReferencedLayer )
230 {
231 QgsVectorLayer *l = mReferencedLayer;
232 const QgsFields &flds = l->fields();
233 for ( int i = 0; i < flds.count(); i++ )
234 {
235 mAvailableFieldsList->addItem( flds.at( i ).displayName() );
236 mAvailableFieldsList->item( mAvailableFieldsList->count() - 1 )->setData( Qt::UserRole, flds.at( i ).name() );
237 }
238 }
239}
240
241void QgsRelationReferenceConfigDlg::addFilterField( const QString &field )
242{
243 for ( int i = 0; i < mAvailableFieldsList->count(); i++ )
244 {
245 if ( mAvailableFieldsList->item( i )->data( Qt::UserRole ).toString() == field )
246 {
247 addFilterField( mAvailableFieldsList->item( i ) );
248 break;
249 }
250 }
251}
252
253void QgsRelationReferenceConfigDlg::addFilterField( QListWidgetItem *item )
254{
255 mAvailableFieldsList->takeItem( indexFromListWidgetItem( item ) );
256 mFilterFieldsList->addItem( item );
257}
258
259int QgsRelationReferenceConfigDlg::indexFromListWidgetItem( QListWidgetItem *item )
260{
261 QListWidget *lw = item->listWidget();
262
263 for ( int i = 0; i < lw->count(); i++ )
264 {
265 if ( lw->item( i ) == item )
266 return i;
267 }
268
269 return -1;
270}
@ Generated
A generated relation is a child of a polymorphic relation.
This class should be subclassed for every configurable editor widget type.
int field()
Returns the field for which this configuration widget applies.
QgsVectorLayer * layer()
Returns the layer for which this configuration widget applies.
void changed()
Emitted when the configuration of the widget is changed.
A generic dialog for building expression strings.
static QgsExpressionContextScope * parentFormScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current parent attribute form/tab...
static QgsExpressionContextScope * formScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current attribute form/table form...
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
The QgsFieldExpressionWidget class creates a widget to choose fields and edit expressions It contains...
void fieldChanged(const QString &fieldName)
Emitted when the currently selected field changes.
QString name
Definition qgsfield.h:62
QString displayName() const
Returns the name to use when displaying this field.
Definition qgsfield.cpp:95
Container of fields for a vector layer.
Definition qgsfields.h:46
int count
Definition qgsfields.h:50
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
QString name
Definition qgsmaplayer.h:80
QString providerType() const
Returns the provider type (provider key) for this layer.
QString id
Definition qgsmaplayer.h:79
QString publicSource(bool hidePassword=false) const
Gets a version of the internal layer definition that has sensitive bits removed (for example,...
QgsRelationManager * relationManager
Definition qgsproject.h:117
static QgsProject * instance()
Returns the QgsProject singleton instance.
Q_INVOKABLE QgsRelation relation(const QString &id) const
Gets access to a relation by its id.
QgsRelationReferenceConfigDlg(QgsVectorLayer *vl, int fieldIdx, QWidget *parent)
void setConfig(const QVariantMap &config) override
Update the configuration widget to represent the given configuration.
QVariantMap config() override
Create a configuration from the current GUI state.
Represents a relationship between two vector layers.
Definition qgsrelation.h:44
QgsVectorLayer * referencedLayer
Definition qgsrelation.h:49
bool referencingFieldsAllowNull() const
Returns true if none of the referencing fields has a NOT NULL constraint.
This class is a composition of two QSettings instances:
Definition qgssettings.h:64
Represents a vector layer which manages a vector based data sets.
bool isSpatial() const FINAL
Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeome...
QList< QgsRelation > referencingRelations(int idx) const
Returns the layer's relations, where the foreign key is on this layer.
void setDisplayExpression(const QString &displayExpression)
Set the preview expression, used to create a human readable preview string.
QString displayExpression