-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgseditformconfig.cpp
773 lines (665 loc) · 27.6 KB
/
qgseditformconfig.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
/***************************************************************************
qgseditformconfig.cpp
---------------------
begin : November 2015
copyright : (C) 2015 by Matthias Kuhn
email : matthias at opengis dot ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgseditformconfig_p.h"
#include "qgseditformconfig.h"
#include "qgsnetworkcontentfetcherregistry.h"
#include "qgspathresolver.h"
#include "qgsproject.h"
#include "qgsreadwritecontext.h"
#include "qgsrelationmanager.h"
#include "qgslogger.h"
#include "qgsxmlutils.h"
#include "qgsapplication.h"
#include "qgsmessagelog.h"
QgsAttributeEditorContainer::~QgsAttributeEditorContainer()
{
qDeleteAll( mChildren );
}
QgsEditFormConfig::QgsEditFormConfig()
: d( new QgsEditFormConfigPrivate() )
{
}
void QgsEditFormConfig::setDataDefinedFieldProperties( const QString &fieldName, const QgsPropertyCollection &properties )
{
d.detach();
d->mDataDefinedFieldProperties[ fieldName ] = properties;
}
QgsPropertyCollection QgsEditFormConfig::dataDefinedFieldProperties( const QString &fieldName ) const
{
return d->mDataDefinedFieldProperties.value( fieldName );
}
const QgsPropertiesDefinition &QgsEditFormConfig::propertyDefinitions()
{
return QgsEditFormConfigPrivate::propertyDefinitions();
}
QVariantMap QgsEditFormConfig::widgetConfig( const QString &widgetName ) const
{
int fieldIndex = d->mFields.indexOf( widgetName );
if ( fieldIndex != -1 )
return d->mFields.at( fieldIndex ).editorWidgetSetup().config();
else
return d->mWidgetConfigs.value( widgetName );
}
void QgsEditFormConfig::setFields( const QgsFields &fields )
{
d.detach();
d->mFields = fields;
if ( !d->mConfiguredRootContainer )
{
d->mInvisibleRootContainer->clear();
for ( int i = 0; i < d->mFields.size(); ++i )
{
QgsAttributeEditorField *field = new QgsAttributeEditorField( d->mFields.at( i ).name(), i, d->mInvisibleRootContainer );
d->mInvisibleRootContainer->addChildElement( field );
}
}
}
void QgsEditFormConfig::onRelationsLoaded()
{
const QList<QgsAttributeEditorElement *> relations = d->mInvisibleRootContainer->findElements( QgsAttributeEditorElement::AeTypeRelation );
for ( QgsAttributeEditorElement *relElem : relations )
{
QgsAttributeEditorRelation *rel = dynamic_cast< QgsAttributeEditorRelation * >( relElem );
if ( !rel )
continue;
rel->init( QgsProject::instance()->relationManager() );
}
}
bool QgsEditFormConfig::legacyUpdateRelationWidgetInTabs( QgsAttributeEditorContainer *container, const QString &widgetName, const QVariantMap &config )
{
const QList<QgsAttributeEditorElement *> children = container->children();
for ( QgsAttributeEditorElement *child : children )
{
if ( child->type() == QgsAttributeEditorElement::AeTypeContainer )
{
QgsAttributeEditorContainer *container = dynamic_cast<QgsAttributeEditorContainer *>( child );
if ( legacyUpdateRelationWidgetInTabs( container, widgetName, config ) )
{
//return when a relation has been set in a child or child child...
return true;
}
}
else if ( child->type() == QgsAttributeEditorElement::AeTypeRelation )
{
QgsAttributeEditorRelation *relation = dynamic_cast< QgsAttributeEditorRelation * >( child );
if ( relation )
{
if ( relation->relation().id() == widgetName )
{
if ( config.contains( QStringLiteral( "nm-rel" ) ) )
{
relation->setNmRelationId( config[QStringLiteral( "nm-rel" )] );
}
if ( config.contains( QStringLiteral( "force-suppress-popup" ) ) )
{
relation->setForceSuppressFormPopup( config[QStringLiteral( "force-suppress-popup" )].toBool() );
}
return true;
}
}
}
}
return false;
}
bool QgsEditFormConfig::setWidgetConfig( const QString &widgetName, const QVariantMap &config )
{
if ( d->mFields.indexOf( widgetName ) != -1 )
{
QgsDebugMsg( QStringLiteral( "Trying to set a widget config for a field on QgsEditFormConfig. Use layer->setEditorWidgetSetup() instead." ) );
return false;
}
//for legacy use it writes the relation editor configuration into the first instance of the widget
if ( config.contains( QStringLiteral( "force-suppress-popup" ) ) || config.contains( QStringLiteral( "nm-rel" ) ) )
{
QgsMessageLog::logMessage( QStringLiteral( "Deprecation Warning: Trying to set a relation config directly on the relation %1. Relation settings should be done for the specific widget instance instead. Use attributeEditorRelation->setNmRelationId() or attributeEditorRelation->setForceSuppressFormPopup() instead." ).arg( widgetName ) );
legacyUpdateRelationWidgetInTabs( d->mInvisibleRootContainer, widgetName, config );
}
d.detach();
d->mWidgetConfigs[widgetName] = config;
return true;
}
bool QgsEditFormConfig::removeWidgetConfig( const QString &widgetName )
{
d.detach();
return d->mWidgetConfigs.remove( widgetName ) != 0;
}
QgsEditFormConfig::QgsEditFormConfig( const QgsEditFormConfig &o ) //NOLINT
: d( o.d )
{
}
QgsEditFormConfig::~QgsEditFormConfig() //NOLINT
{}
QgsEditFormConfig &QgsEditFormConfig::operator=( const QgsEditFormConfig &o ) //NOLINT
{
d = o.d;
return *this;
}
bool QgsEditFormConfig::operator==( const QgsEditFormConfig &o )
{
return d == o.d;
}
void QgsEditFormConfig::addTab( QgsAttributeEditorElement *data )
{
d.detach();
d->mInvisibleRootContainer->addChildElement( data );
}
QList<QgsAttributeEditorElement *> QgsEditFormConfig::tabs() const
{
return d->mInvisibleRootContainer->children();
}
void QgsEditFormConfig::clearTabs()
{
d.detach();
d->mInvisibleRootContainer->clear();
}
QgsAttributeEditorContainer *QgsEditFormConfig::invisibleRootContainer()
{
return d->mInvisibleRootContainer;
}
QgsEditFormConfig::EditorLayout QgsEditFormConfig::layout() const
{
return d->mEditorLayout;
}
void QgsEditFormConfig::setLayout( QgsEditFormConfig::EditorLayout editorLayout )
{
d.detach();
d->mEditorLayout = editorLayout;
if ( editorLayout == TabLayout )
d->mConfiguredRootContainer = true;
}
QString QgsEditFormConfig::uiForm() const
{
return d->mUiFormPath;
}
void QgsEditFormConfig::setUiForm( const QString &ui )
{
if ( !ui.isEmpty() && !QUrl::fromUserInput( ui ).isLocalFile() )
{
// any existing download will not be restarted!
QgsApplication::instance()->networkContentFetcherRegistry()->fetch( ui, QgsNetworkContentFetcherRegistry::DownloadImmediately );
}
if ( ui.isEmpty() )
{
setLayout( GeneratedLayout );
}
else
{
setLayout( UiFileLayout );
}
d->mUiFormPath = ui;
}
bool QgsEditFormConfig::readOnly( int idx ) const
{
if ( idx >= 0 && idx < d->mFields.count() )
{
if ( d->mFields.fieldOrigin( idx ) == QgsFields::OriginJoin
|| d->mFields.fieldOrigin( idx ) == QgsFields::OriginExpression )
return true;
return !d->mFieldEditables.value( d->mFields.at( idx ).name(), true );
}
else
return false;
}
bool QgsEditFormConfig::labelOnTop( int idx ) const
{
if ( idx >= 0 && idx < d->mFields.count() )
return d->mLabelOnTop.value( d->mFields.at( idx ).name(), false );
else
return false;
}
void QgsEditFormConfig::setReadOnly( int idx, bool readOnly )
{
if ( idx >= 0 && idx < d->mFields.count() )
{
d.detach();
d->mFieldEditables[ d->mFields.at( idx ).name()] = !readOnly;
}
}
void QgsEditFormConfig::setLabelOnTop( int idx, bool onTop )
{
if ( idx >= 0 && idx < d->mFields.count() )
{
d.detach();
d->mLabelOnTop[ d->mFields.at( idx ).name()] = onTop;
}
}
QString QgsEditFormConfig::initFunction() const
{
return d->mInitFunction;
}
void QgsEditFormConfig::setInitFunction( const QString &function )
{
d.detach();
d->mInitFunction = function;
}
QString QgsEditFormConfig::initCode() const
{
return d->mInitCode;
}
void QgsEditFormConfig::setInitCode( const QString &code )
{
d.detach();
d->mInitCode = code;
}
QString QgsEditFormConfig::initFilePath() const
{
return d->mInitFilePath;
}
void QgsEditFormConfig::setInitFilePath( const QString &filePath )
{
d.detach();
d->mInitFilePath = filePath;
// if this is an URL, download file as there is a good chance it will be used later
if ( !filePath.isEmpty() && !QUrl::fromUserInput( filePath ).isLocalFile() )
{
// any existing download will not be restarted!
QgsApplication::instance()->networkContentFetcherRegistry()->fetch( filePath, QgsNetworkContentFetcherRegistry::DownloadImmediately );
}
}
QgsEditFormConfig::PythonInitCodeSource QgsEditFormConfig::initCodeSource() const
{
return d->mInitCodeSource;
}
void QgsEditFormConfig::setInitCodeSource( const QgsEditFormConfig::PythonInitCodeSource initCodeSource )
{
d.detach();
d->mInitCodeSource = initCodeSource;
}
QgsEditFormConfig::FeatureFormSuppress QgsEditFormConfig::suppress() const
{
return d->mSuppressForm;
}
void QgsEditFormConfig::setSuppress( QgsEditFormConfig::FeatureFormSuppress s )
{
d.detach();
d->mSuppressForm = s;
}
void QgsEditFormConfig::readXml( const QDomNode &node, QgsReadWriteContext &context )
{
QgsReadWriteContextCategoryPopper p = context.enterCategory( QObject::tr( "Edit form config" ) );
d.detach();
QDomNode editFormNode = node.namedItem( QStringLiteral( "editform" ) );
if ( !editFormNode.isNull() )
{
QDomElement e = editFormNode.toElement();
const bool tolerantRemoteUrls = e.hasAttribute( QStringLiteral( "tolerant" ) );
if ( !e.text().isEmpty() )
{
const QString uiFormPath = context.pathResolver().readPath( e.text() );
// <= 3.2 had a bug where invalid ui paths would get written into projects on load
// to avoid restoring these invalid paths, we take a less-tolerant approach for older (untrustworthy) projects
// and only set ui forms paths IF they are local files OR start with "http(s)".
const bool localFile = QFileInfo::exists( uiFormPath );
if ( localFile || tolerantRemoteUrls || uiFormPath.startsWith( QLatin1String( "http" ) ) )
setUiForm( uiFormPath );
}
}
QDomNode editFormInitNode = node.namedItem( QStringLiteral( "editforminit" ) );
if ( !editFormInitNode.isNull() )
{
d->mInitFunction = editFormInitNode.toElement().text();
}
QDomNode editFormInitCodeSourceNode = node.namedItem( QStringLiteral( "editforminitcodesource" ) );
if ( !editFormInitCodeSourceNode.isNull() && !editFormInitCodeSourceNode.toElement().text().isEmpty() )
{
setInitCodeSource( static_cast< QgsEditFormConfig::PythonInitCodeSource >( editFormInitCodeSourceNode.toElement().text().toInt() ) );
}
QDomNode editFormInitCodeNode = node.namedItem( QStringLiteral( "editforminitcode" ) );
if ( !editFormInitCodeNode.isNull() )
{
setInitCode( editFormInitCodeNode.toElement().text() );
}
// Temporary < 2.12 b/w compatibility "dot" support patch
// \see: https://github.com/qgis/QGIS/pull/2498
// For b/w compatibility, check if there's a dot in the function name
// and if yes, transform it in an import statement for the module
// and set the PythonInitCodeSource to CodeSourceDialog
int dotPos = d->mInitFunction.lastIndexOf( '.' );
if ( dotPos >= 0 ) // It's a module
{
setInitCodeSource( QgsEditFormConfig::CodeSourceDialog );
setInitCode( QStringLiteral( "from %1 import %2\n" ).arg( d->mInitFunction.left( dotPos ), d->mInitFunction.mid( dotPos + 1 ) ) );
setInitFunction( d->mInitFunction.mid( dotPos + 1 ) );
}
QDomNode editFormInitFilePathNode = node.namedItem( QStringLiteral( "editforminitfilepath" ) );
if ( !editFormInitFilePathNode.isNull() && !editFormInitFilePathNode.toElement().text().isEmpty() )
{
setInitFilePath( context.pathResolver().readPath( editFormInitFilePathNode.toElement().text() ) );
}
QDomNode fFSuppNode = node.namedItem( QStringLiteral( "featformsuppress" ) );
if ( fFSuppNode.isNull() )
{
d->mSuppressForm = QgsEditFormConfig::SuppressDefault;
}
else
{
QDomElement e = fFSuppNode.toElement();
d->mSuppressForm = static_cast< QgsEditFormConfig::FeatureFormSuppress >( e.text().toInt() );
}
// tab display
QDomNode editorLayoutNode = node.namedItem( QStringLiteral( "editorlayout" ) );
if ( editorLayoutNode.isNull() )
{
d->mEditorLayout = QgsEditFormConfig::GeneratedLayout;
}
else
{
if ( editorLayoutNode.toElement().text() == QLatin1String( "uifilelayout" ) )
{
d->mEditorLayout = QgsEditFormConfig::UiFileLayout;
}
else if ( editorLayoutNode.toElement().text() == QLatin1String( "tablayout" ) )
{
d->mEditorLayout = QgsEditFormConfig::TabLayout;
}
else
{
d->mEditorLayout = QgsEditFormConfig::GeneratedLayout;
}
}
d->mFieldEditables.clear();
QDomNodeList editableNodeList = node.namedItem( QStringLiteral( "editable" ) ).toElement().childNodes();
for ( int i = 0; i < editableNodeList.size(); ++i )
{
QDomElement editableElement = editableNodeList.at( i ).toElement();
d->mFieldEditables.insert( editableElement.attribute( QStringLiteral( "name" ) ), static_cast< bool >( editableElement.attribute( QStringLiteral( "editable" ) ).toInt() ) );
}
d->mLabelOnTop.clear();
QDomNodeList labelOnTopNodeList = node.namedItem( QStringLiteral( "labelOnTop" ) ).toElement().childNodes();
for ( int i = 0; i < labelOnTopNodeList.size(); ++i )
{
QDomElement labelOnTopElement = labelOnTopNodeList.at( i ).toElement();
d->mLabelOnTop.insert( labelOnTopElement.attribute( QStringLiteral( "name" ) ), static_cast< bool >( labelOnTopElement.attribute( QStringLiteral( "labelOnTop" ) ).toInt() ) );
}
// Read data defined field properties
QDomNodeList fieldDDPropertiesNodeList = node.namedItem( QStringLiteral( "dataDefinedFieldProperties" ) ).toElement().childNodes();
for ( int i = 0; i < fieldDDPropertiesNodeList.size(); ++i )
{
QDomElement DDElement = fieldDDPropertiesNodeList.at( i ).toElement();
QgsPropertyCollection collection;
collection.readXml( DDElement, propertyDefinitions() );
d->mDataDefinedFieldProperties.insert( DDElement.attribute( QStringLiteral( "name" ) ), collection );
}
QDomNodeList widgetsNodeList = node.namedItem( QStringLiteral( "widgets" ) ).toElement().childNodes();
for ( int i = 0; i < widgetsNodeList.size(); ++i )
{
QDomElement widgetElement = widgetsNodeList.at( i ).toElement();
QVariant config = QgsXmlUtils::readVariant( widgetElement.firstChildElement( QStringLiteral( "config" ) ) );
d->mWidgetConfigs[widgetElement.attribute( QStringLiteral( "name" ) )] = config.toMap();
}
// tabs and groups display info
QDomNode attributeEditorFormNode = node.namedItem( QStringLiteral( "attributeEditorForm" ) );
if ( !attributeEditorFormNode.isNull() )
{
QDomNodeList attributeEditorFormNodeList = attributeEditorFormNode.toElement().childNodes();
if ( attributeEditorFormNodeList.size() )
{
d->mConfiguredRootContainer = true;
clearTabs();
for ( int i = 0; i < attributeEditorFormNodeList.size(); i++ )
{
QDomElement elem = attributeEditorFormNodeList.at( i ).toElement();
QgsAttributeEditorElement *attributeEditorWidget = attributeEditorElementFromDomElement( elem, nullptr, node.namedItem( QStringLiteral( "id" ) ).toElement().text(), context );
if ( attributeEditorWidget )
addTab( attributeEditorWidget );
}
onRelationsLoaded();
}
}
}
void QgsEditFormConfig::writeXml( QDomNode &node, const QgsReadWriteContext &context ) const
{
QDomDocument doc( node.ownerDocument() );
QDomElement efField = doc.createElement( QStringLiteral( "editform" ) );
efField.setAttribute( QStringLiteral( "tolerant" ), QStringLiteral( "1" ) );
QDomText efText = doc.createTextNode( context.pathResolver().writePath( uiForm() ) );
efField.appendChild( efText );
node.appendChild( efField );
QDomElement efiField = doc.createElement( QStringLiteral( "editforminit" ) );
if ( !initFunction().isEmpty() )
efiField.appendChild( doc.createTextNode( initFunction() ) );
node.appendChild( efiField );
QDomElement eficsField = doc.createElement( QStringLiteral( "editforminitcodesource" ) );
eficsField.appendChild( doc.createTextNode( QString::number( initCodeSource() ) ) );
node.appendChild( eficsField );
QDomElement efifpField = doc.createElement( QStringLiteral( "editforminitfilepath" ) );
efifpField.appendChild( doc.createTextNode( context.pathResolver().writePath( initFilePath() ) ) );
node.appendChild( efifpField );
QDomElement eficField = doc.createElement( QStringLiteral( "editforminitcode" ) );
eficField.appendChild( doc.createCDATASection( initCode() ) );
node.appendChild( eficField );
QDomElement fFSuppElem = doc.createElement( QStringLiteral( "featformsuppress" ) );
QDomText fFSuppText = doc.createTextNode( QString::number( suppress() ) );
fFSuppElem.appendChild( fFSuppText );
node.appendChild( fFSuppElem );
// tab display
QDomElement editorLayoutElem = doc.createElement( QStringLiteral( "editorlayout" ) );
switch ( layout() )
{
case QgsEditFormConfig::UiFileLayout:
editorLayoutElem.appendChild( doc.createTextNode( QStringLiteral( "uifilelayout" ) ) );
break;
case QgsEditFormConfig::TabLayout:
editorLayoutElem.appendChild( doc.createTextNode( QStringLiteral( "tablayout" ) ) );
break;
case QgsEditFormConfig::GeneratedLayout:
default:
editorLayoutElem.appendChild( doc.createTextNode( QStringLiteral( "generatedlayout" ) ) );
break;
}
node.appendChild( editorLayoutElem );
// tabs and groups of edit form
if ( !tabs().empty() && d->mConfiguredRootContainer )
{
QDomElement tabsElem = doc.createElement( QStringLiteral( "attributeEditorForm" ) );
QDomElement rootElem = d->mInvisibleRootContainer->toDomElement( doc );
QDomNodeList elemList = rootElem.childNodes();
while ( !elemList.isEmpty() )
{
tabsElem.appendChild( elemList.at( 0 ) );
}
node.appendChild( tabsElem );
}
QDomElement editableElem = doc.createElement( QStringLiteral( "editable" ) );
for ( auto editIt = d->mFieldEditables.constBegin(); editIt != d->mFieldEditables.constEnd(); ++editIt )
{
QDomElement fieldElem = doc.createElement( QStringLiteral( "field" ) );
fieldElem.setAttribute( QStringLiteral( "name" ), editIt.key() );
fieldElem.setAttribute( QStringLiteral( "editable" ), editIt.value() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
editableElem.appendChild( fieldElem );
}
node.appendChild( editableElem );
QDomElement labelOnTopElem = doc.createElement( QStringLiteral( "labelOnTop" ) );
for ( auto labelOnTopIt = d->mLabelOnTop.constBegin(); labelOnTopIt != d->mLabelOnTop.constEnd(); ++labelOnTopIt )
{
QDomElement fieldElem = doc.createElement( QStringLiteral( "field" ) );
fieldElem.setAttribute( QStringLiteral( "name" ), labelOnTopIt.key() );
fieldElem.setAttribute( QStringLiteral( "labelOnTop" ), labelOnTopIt.value() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
labelOnTopElem.appendChild( fieldElem );
}
node.appendChild( labelOnTopElem );
// Store data defined field properties
QDomElement ddFieldPropsElement = doc.createElement( QStringLiteral( "dataDefinedFieldProperties" ) );
for ( auto it = d->mDataDefinedFieldProperties.constBegin(); it != d->mDataDefinedFieldProperties.constEnd(); ++it )
{
QDomElement ddPropsElement = doc.createElement( QStringLiteral( "field" ) );
ddPropsElement.setAttribute( QStringLiteral( "name" ), it.key() );
it.value().writeXml( ddPropsElement, propertyDefinitions() );
ddFieldPropsElement.appendChild( ddPropsElement );
}
node.appendChild( ddFieldPropsElement );
QDomElement widgetsElem = doc.createElement( QStringLiteral( "widgets" ) );
QMap<QString, QVariantMap >::ConstIterator configIt( d->mWidgetConfigs.constBegin() );
while ( configIt != d->mWidgetConfigs.constEnd() )
{
QDomElement widgetElem = doc.createElement( QStringLiteral( "widget" ) );
widgetElem.setAttribute( QStringLiteral( "name" ), configIt.key() );
// widgetElem.setAttribute( "notNull", );
QDomElement configElem = QgsXmlUtils::writeVariant( configIt.value(), doc );
configElem.setTagName( QStringLiteral( "config" ) );
widgetElem.appendChild( configElem );
widgetsElem.appendChild( widgetElem );
++configIt;
}
node.appendChild( widgetsElem );
//// END TODO
}
QgsAttributeEditorElement *QgsEditFormConfig::attributeEditorElementFromDomElement( QDomElement &elem, QgsAttributeEditorElement *parent, const QString &layerId, const QgsReadWriteContext &context )
{
QgsAttributeEditorElement *newElement = nullptr;
if ( elem.tagName() == QLatin1String( "attributeEditorContainer" ) )
{
QColor backgroundColor( elem.attribute( QStringLiteral( "backgroundColor" ), QString() ) );
QgsAttributeEditorContainer *container = new QgsAttributeEditorContainer( context.projectTranslator()->translate( QStringLiteral( "project:layers:%1:formcontainers" ).arg( layerId ),
elem.attribute( QStringLiteral( "name" ) ) ), parent, backgroundColor );
bool ok;
int cc = elem.attribute( QStringLiteral( "columnCount" ) ).toInt( &ok );
if ( !ok )
cc = 0;
container->setColumnCount( cc );
bool isGroupBox = elem.attribute( QStringLiteral( "groupBox" ) ).toInt( &ok );
if ( ok )
container->setIsGroupBox( isGroupBox );
else
container->setIsGroupBox( parent );
bool visibilityExpressionEnabled = elem.attribute( QStringLiteral( "visibilityExpressionEnabled" ) ).toInt( &ok );
QgsOptionalExpression visibilityExpression;
if ( ok )
{
visibilityExpression.setEnabled( visibilityExpressionEnabled );
visibilityExpression.setData( QgsExpression( elem.attribute( QStringLiteral( "visibilityExpression" ) ) ) );
}
container->setVisibilityExpression( visibilityExpression );
QDomNodeList childNodeList = elem.childNodes();
for ( int i = 0; i < childNodeList.size(); i++ )
{
QDomElement childElem = childNodeList.at( i ).toElement();
QgsAttributeEditorElement *myElem = attributeEditorElementFromDomElement( childElem, container, layerId, context );
if ( myElem )
container->addChildElement( myElem );
}
newElement = container;
}
else if ( elem.tagName() == QLatin1String( "attributeEditorField" ) )
{
QString name = elem.attribute( QStringLiteral( "name" ) );
int idx = d->mFields.lookupField( name );
newElement = new QgsAttributeEditorField( name, idx, parent );
}
else if ( elem.tagName() == QLatin1String( "attributeEditorRelation" ) )
{
// At this time, the relations are not loaded
// So we only grab the id and delegate the rest to onRelationsLoaded()
QgsAttributeEditorRelation *relElement = new QgsAttributeEditorRelation( elem.attribute( QStringLiteral( "relation" ), QStringLiteral( "[None]" ) ), parent );
if ( elem.hasAttribute( "buttons" ) )
{
QString buttonString = elem.attribute( QStringLiteral( "buttons" ), qgsFlagValueToKeys( QgsAttributeEditorRelation::Button::AllButtons ) );
relElement->setVisibleButtons( qgsFlagKeysToValue( buttonString, QgsAttributeEditorRelation::Button::AllButtons ) );
}
else
{
// pre QGIS 3.16 compatibility
QgsAttributeEditorRelation::Buttons buttons = QgsAttributeEditorRelation::Button::AllButtons;
buttons.setFlag( QgsAttributeEditorRelation::Button::Link, elem.attribute( QStringLiteral( "showLinkButton" ), QStringLiteral( "1" ) ).toInt() );
buttons.setFlag( QgsAttributeEditorRelation::Button::Unlink, elem.attribute( QStringLiteral( "showUnlinkButton" ), QStringLiteral( "1" ) ).toInt() );
buttons.setFlag( QgsAttributeEditorRelation::Button::SaveChildEdits, elem.attribute( QStringLiteral( "showSaveChildEditsButton" ), QStringLiteral( "1" ) ).toInt() );
relElement->setVisibleButtons( buttons );
}
if ( elem.hasAttribute( QStringLiteral( "forceSuppressFormPopup" ) ) )
{
relElement->setForceSuppressFormPopup( elem.attribute( QStringLiteral( "forceSuppressFormPopup" ) ).toInt() );
}
else
{
// pre QGIS 3.16 compatibility - the widgets section is read before
relElement->setForceSuppressFormPopup( widgetConfig( elem.attribute( QStringLiteral( "relation" ) ) ).value( QStringLiteral( "force-suppress-popup" ), false ).toBool() );
}
if ( elem.hasAttribute( QStringLiteral( "nmRelationId" ) ) )
{
relElement->setNmRelationId( elem.attribute( QStringLiteral( "nmRelationId" ) ) );
}
else
{
// pre QGIS 3.16 compatibility - the widgets section is read before
relElement->setNmRelationId( widgetConfig( elem.attribute( QStringLiteral( "relation" ) ) ).value( QStringLiteral( "nm-rel" ) ) );
}
if ( elem.hasAttribute( "label" ) )
{
QString label = elem.attribute( QStringLiteral( "label" ) );
relElement->setLabel( label );
}
newElement = relElement;
}
else if ( elem.tagName() == QLatin1String( "attributeEditorQmlElement" ) )
{
QgsAttributeEditorQmlElement *qmlElement = new QgsAttributeEditorQmlElement( elem.attribute( QStringLiteral( "name" ) ), parent );
qmlElement->setQmlCode( elem.text() );
newElement = qmlElement;
}
else if ( elem.tagName() == QLatin1String( "attributeEditorHtmlElement" ) )
{
QgsAttributeEditorHtmlElement *htmlElement = new QgsAttributeEditorHtmlElement( elem.attribute( QStringLiteral( "name" ) ), parent );
htmlElement->setHtmlCode( elem.text() );
newElement = htmlElement;
}
if ( newElement )
{
if ( elem.hasAttribute( QStringLiteral( "showLabel" ) ) )
newElement->setShowLabel( elem.attribute( QStringLiteral( "showLabel" ) ).toInt() );
else
newElement->setShowLabel( true );
}
return newElement;
}
int QgsAttributeEditorContainer::columnCount() const
{
return mColumnCount;
}
void QgsAttributeEditorContainer::setColumnCount( int columnCount )
{
mColumnCount = columnCount;
}
QgsAttributeEditorElement *QgsAttributeEditorContainer::clone( QgsAttributeEditorElement *parent ) const
{
QgsAttributeEditorContainer *element = new QgsAttributeEditorContainer( name(), parent );
const auto childElements = children();
for ( QgsAttributeEditorElement *child : childElements )
{
element->addChildElement( child->clone( element ) );
}
element->mIsGroupBox = mIsGroupBox;
element->mColumnCount = mColumnCount;
element->mVisibilityExpression = mVisibilityExpression;
return element;
}
void QgsAttributeEditorContainer::saveConfiguration( QDomElement &elem ) const
{
elem.setAttribute( QStringLiteral( "columnCount" ), mColumnCount );
elem.setAttribute( QStringLiteral( "groupBox" ), mIsGroupBox ? 1 : 0 );
elem.setAttribute( QStringLiteral( "visibilityExpressionEnabled" ), mVisibilityExpression.enabled() ? 1 : 0 );
elem.setAttribute( QStringLiteral( "visibilityExpression" ), mVisibilityExpression->expression() );
if ( mBackgroundColor.isValid() )
elem.setAttribute( QStringLiteral( "backgroundColor" ), mBackgroundColor.name( ) );
const auto constMChildren = mChildren;
for ( QgsAttributeEditorElement *child : constMChildren )
{
QDomDocument doc = elem.ownerDocument();
elem.appendChild( child->toDomElement( doc ) );
}
}
QString QgsAttributeEditorContainer::typeIdentifier() const
{
return QStringLiteral( "attributeEditorContainer" );
}