-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgslayout.cpp
848 lines (727 loc) · 24.4 KB
/
qgslayout.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
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
/***************************************************************************
qgslayout.cpp
-------------------
begin : June 2017
copyright : (C) 2017 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/
/***************************************************************************
* *
* 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 "qgslayout.h"
#include "qgslayoutitem.h"
#include "qgslayoutmodel.h"
#include "qgslayoutpagecollection.h"
#include "qgslayoutguidecollection.h"
#include "qgsreadwritecontext.h"
#include "qgsproject.h"
#include "qgslayoutitemundocommand.h"
#include "qgslayoutitemgroup.h"
#include "qgslayoutitemgroupundocommand.h"
#include "qgslayoutmultiframe.h"
QgsLayout::QgsLayout( QgsProject *project )
: mProject( project )
, mSnapper( QgsLayoutSnapper( this ) )
, mGridSettings( this )
, mPageCollection( new QgsLayoutPageCollection( this ) )
, mUndoStack( new QgsLayoutUndoStack( this ) )
, mExporter( QgsLayoutExporter( this ) )
{
// just to make sure - this should be the default, but maybe it'll change in some future Qt version...
setBackgroundBrush( Qt::NoBrush );
mItemsModel.reset( new QgsLayoutModel( this ) );
}
QgsLayout::~QgsLayout()
{
// no need for undo commands when we're destroying the layout
mUndoStack->blockCommands( true );
deleteAndRemoveMultiFrames();
// make sure that all layout items are removed before
// this class is deconstructed - to avoid segfaults
// when layout items access in destructor layout that isn't valid anymore
// since deletion of some item types (e.g. groups) trigger deletion
// of other items, we have to do this careful, one at a time...
QList<QGraphicsItem *> itemList = items();
bool deleted = true;
while ( deleted )
{
deleted = false;
for ( QGraphicsItem *item : qgis::as_const( itemList ) )
{
if ( dynamic_cast< QgsLayoutItem * >( item ) && !dynamic_cast< QgsLayoutItemPage *>( item ) )
{
delete item;
deleted = true;
break;
}
}
itemList = items();
}
mItemsModel.reset(); // manually delete, so we can control order of destruction
}
void QgsLayout::initializeDefaults()
{
// default to a A4 landscape page
QgsLayoutItemPage *page = new QgsLayoutItemPage( this );
page->setPageSize( QgsLayoutSize( 297, 210, QgsUnitTypes::LayoutMillimeters ) );
mPageCollection->addPage( page );
mUndoStack->stack()->clear();
}
QgsProject *QgsLayout::project() const
{
return mProject;
}
QgsLayoutModel *QgsLayout::itemsModel()
{
return mItemsModel.get();
}
QgsLayoutExporter &QgsLayout::exporter()
{
return mExporter;
}
QList<QgsLayoutItem *> QgsLayout::selectedLayoutItems( const bool includeLockedItems )
{
QList<QgsLayoutItem *> layoutItemList;
const QList<QGraphicsItem *> graphicsItemList = selectedItems();
for ( QGraphicsItem *item : graphicsItemList )
{
QgsLayoutItem *layoutItem = dynamic_cast<QgsLayoutItem *>( item );
if ( layoutItem && ( includeLockedItems || !layoutItem->isLocked() ) )
{
layoutItemList.push_back( layoutItem );
}
}
return layoutItemList;
}
void QgsLayout::setSelectedItem( QgsLayoutItem *item )
{
whileBlocking( this )->deselectAll();
if ( item )
{
item->setSelected( true );
}
emit selectedItemChanged( item );
}
void QgsLayout::deselectAll()
{
//we can't use QGraphicsScene::clearSelection, as that emits no signals
//and we don't know which items are being deselected
//accordingly, we can't inform the layout model of selection changes
//instead, do the clear selection manually...
const QList<QGraphicsItem *> selectedItemList = selectedItems();
for ( QGraphicsItem *item : selectedItemList )
{
if ( QgsLayoutItem *layoutItem = dynamic_cast<QgsLayoutItem *>( item ) )
{
layoutItem->setSelected( false );
}
}
emit selectedItemChanged( nullptr );
}
bool QgsLayout::raiseItem( QgsLayoutItem *item, bool deferUpdate )
{
//model handles reordering items
bool result = mItemsModel->reorderItemUp( item );
if ( result && !deferUpdate )
{
//update all positions
updateZValues();
update();
}
return result;
}
bool QgsLayout::lowerItem( QgsLayoutItem *item, bool deferUpdate )
{
//model handles reordering items
bool result = mItemsModel->reorderItemDown( item );
if ( result && !deferUpdate )
{
//update all positions
updateZValues();
update();
}
return result;
}
bool QgsLayout::moveItemToTop( QgsLayoutItem *item, bool deferUpdate )
{
//model handles reordering items
bool result = mItemsModel->reorderItemToTop( item );
if ( result && !deferUpdate )
{
//update all positions
updateZValues();
update();
}
return result;
}
bool QgsLayout::moveItemToBottom( QgsLayoutItem *item, bool deferUpdate )
{
//model handles reordering items
bool result = mItemsModel->reorderItemToBottom( item );
if ( result && !deferUpdate )
{
//update all positions
updateZValues();
update();
}
return result;
}
QgsLayoutItem *QgsLayout::itemByUuid( const QString &uuid )
{
QList<QgsLayoutItem *> itemList;
layoutItems( itemList );
Q_FOREACH ( QgsLayoutItem *item, itemList )
{
if ( item->uuid() == uuid )
{
return item;
}
}
return nullptr;
}
QgsLayoutMultiFrame *QgsLayout::multiFrameByUuid( const QString &uuid ) const
{
for ( QgsLayoutMultiFrame *mf : mMultiFrames )
{
if ( mf->uuid() == uuid )
{
return mf;
}
}
return nullptr;
}
QgsLayoutItem *QgsLayout::layoutItemAt( QPointF position, const bool ignoreLocked ) const
{
return layoutItemAt( position, nullptr, ignoreLocked );
}
QgsLayoutItem *QgsLayout::layoutItemAt( QPointF position, const QgsLayoutItem *belowItem, const bool ignoreLocked ) const
{
//get a list of items which intersect the specified position, in descending z order
const QList<QGraphicsItem *> itemList = items( position, Qt::IntersectsItemShape, Qt::DescendingOrder );
bool foundBelowItem = false;
for ( QGraphicsItem *graphicsItem : itemList )
{
QgsLayoutItem *layoutItem = dynamic_cast<QgsLayoutItem *>( graphicsItem );
QgsLayoutItemPage *paperItem = dynamic_cast<QgsLayoutItemPage *>( layoutItem );
if ( layoutItem && !paperItem )
{
// If we are not checking for a an item below a specified item, or if we've
// already found that item, then we've found our target
if ( ( ! belowItem || foundBelowItem ) && ( !ignoreLocked || !layoutItem->isLocked() ) )
{
return layoutItem;
}
else
{
if ( layoutItem == belowItem )
{
//Target item is next in list
foundBelowItem = true;
}
}
}
}
return nullptr;
}
double QgsLayout::convertToLayoutUnits( const QgsLayoutMeasurement &measurement ) const
{
return mContext.measurementConverter().convert( measurement, mUnits ).length();
}
QSizeF QgsLayout::convertToLayoutUnits( const QgsLayoutSize &size ) const
{
return mContext.measurementConverter().convert( size, mUnits ).toQSizeF();
}
QPointF QgsLayout::convertToLayoutUnits( const QgsLayoutPoint &point ) const
{
return mContext.measurementConverter().convert( point, mUnits ).toQPointF();
}
QgsLayoutMeasurement QgsLayout::convertFromLayoutUnits( const double length, const QgsUnitTypes::LayoutUnit unit ) const
{
return mContext.measurementConverter().convert( QgsLayoutMeasurement( length, mUnits ), unit );
}
QgsLayoutSize QgsLayout::convertFromLayoutUnits( const QSizeF &size, const QgsUnitTypes::LayoutUnit unit ) const
{
return mContext.measurementConverter().convert( QgsLayoutSize( size.width(), size.height(), mUnits ), unit );
}
QgsLayoutPoint QgsLayout::convertFromLayoutUnits( const QPointF &point, const QgsUnitTypes::LayoutUnit unit ) const
{
return mContext.measurementConverter().convert( QgsLayoutPoint( point.x(), point.y(), mUnits ), unit );
}
QgsLayoutGuideCollection &QgsLayout::guides()
{
return mPageCollection->guides();
}
const QgsLayoutGuideCollection &QgsLayout::guides() const
{
return mPageCollection->guides();
}
QgsExpressionContext QgsLayout::createExpressionContext() const
{
QgsExpressionContext context = QgsExpressionContext();
context.appendScope( QgsExpressionContextUtils::globalScope() );
context.appendScope( QgsExpressionContextUtils::projectScope( mProject ) );
context.appendScope( QgsExpressionContextUtils::layoutScope( this ) );
#if 0 //TODO
if ( mAtlasComposition.enabled() )
{
context.appendScope( QgsExpressionContextUtils::atlasScope( &mAtlasComposition ) );
}
#endif
return context;
}
void QgsLayout::setCustomProperty( const QString &key, const QVariant &value )
{
mCustomProperties.setValue( key, value );
if ( key.startsWith( QLatin1String( "variable" ) ) )
emit variablesChanged();
}
QVariant QgsLayout::customProperty( const QString &key, const QVariant &defaultValue ) const
{
return mCustomProperties.value( key, defaultValue );
}
void QgsLayout::removeCustomProperty( const QString &key )
{
mCustomProperties.remove( key );
}
QStringList QgsLayout::customProperties() const
{
return mCustomProperties.keys();
}
QgsLayoutItemMap *QgsLayout::referenceMap() const
{
return nullptr;
}
void QgsLayout::setReferenceMap( QgsLayoutItemMap *map )
{
Q_UNUSED( map );
}
QgsLayoutPageCollection *QgsLayout::pageCollection()
{
return mPageCollection.get();
}
const QgsLayoutPageCollection *QgsLayout::pageCollection() const
{
return mPageCollection.get();
}
QRectF QgsLayout::layoutBounds( bool ignorePages, double margin ) const
{
//start with an empty rectangle
QRectF bounds;
//add all QgsComposerItems and QgsPaperItems which are in the composition
Q_FOREACH ( const QGraphicsItem *item, items() )
{
const QgsLayoutItem *layoutItem = dynamic_cast<const QgsLayoutItem *>( item );
if ( !layoutItem )
continue;
bool isPage = layoutItem->type() == QgsLayoutItemRegistry::LayoutPage;
if ( !isPage || !ignorePages )
{
//expand bounds with current item's bounds
QRectF itemBounds;
if ( isPage )
{
// for pages we only consider the item's rect - not the bounding rect
// as the bounding rect contains extra padding
itemBounds = layoutItem->mapToScene( layoutItem->rect() ).boundingRect();
}
else
itemBounds = item->sceneBoundingRect();
if ( bounds.isValid() )
bounds = bounds.united( itemBounds );
else
bounds = itemBounds;
}
}
if ( bounds.isValid() && margin > 0.0 )
{
//finally, expand bounds out by specified margin of page size
double maxWidth = mPageCollection->maximumPageWidth();
bounds.adjust( -maxWidth * margin, -maxWidth * margin, maxWidth * margin, maxWidth * margin );
}
return bounds;
}
void QgsLayout::addLayoutItem( QgsLayoutItem *item )
{
addLayoutItemPrivate( item );
QString undoText;
if ( QgsLayoutItemAbstractMetadata *metadata = QgsApplication::layoutItemRegistry()->itemMetadata( item->type() ) )
{
undoText = tr( "Create %1" ).arg( metadata->visibleName() );
}
else
{
undoText = tr( "Create Item" );
}
if ( !mUndoStack->isBlocked() )
mUndoStack->push( new QgsLayoutItemAddItemCommand( item, undoText ) );
}
void QgsLayout::removeLayoutItem( QgsLayoutItem *item )
{
std::unique_ptr< QgsLayoutItemDeleteUndoCommand > deleteCommand;
if ( !mUndoStack->isBlocked() )
{
mUndoStack->beginMacro( tr( "Delete Items" ) );
deleteCommand.reset( new QgsLayoutItemDeleteUndoCommand( item, tr( "Delete Item" ) ) );
}
removeLayoutItemPrivate( item );
if ( deleteCommand )
{
mUndoStack->push( deleteCommand.release() );
mUndoStack->endMacro();
}
}
void QgsLayout::addMultiFrame( QgsLayoutMultiFrame *multiFrame )
{
if ( !multiFrame )
return;
if ( !mMultiFrames.contains( multiFrame ) )
mMultiFrames << multiFrame;
}
void QgsLayout::removeMultiFrame( QgsLayoutMultiFrame *multiFrame )
{
mMultiFrames.removeAll( multiFrame );
}
QList<QgsLayoutMultiFrame *> QgsLayout::multiFrames() const
{
return mMultiFrames;
}
QgsLayoutUndoStack *QgsLayout::undoStack()
{
return mUndoStack.get();
}
const QgsLayoutUndoStack *QgsLayout::undoStack() const
{
return mUndoStack.get();
}
///@cond PRIVATE
class QgsLayoutUndoCommand: public QgsAbstractLayoutUndoCommand
{
public:
QgsLayoutUndoCommand( QgsLayout *layout, const QString &text, int id, QUndoCommand *parent SIP_TRANSFERTHIS = nullptr )
: QgsAbstractLayoutUndoCommand( text, id, parent )
, mLayout( layout )
{}
protected:
void saveState( QDomDocument &stateDoc ) const override
{
stateDoc.clear();
QDomElement documentElement = stateDoc.createElement( QStringLiteral( "UndoState" ) );
mLayout->writeXmlLayoutSettings( documentElement, stateDoc, QgsReadWriteContext() );
stateDoc.appendChild( documentElement );
}
void restoreState( QDomDocument &stateDoc ) override
{
if ( !mLayout )
{
return;
}
mLayout->readXmlLayoutSettings( stateDoc.documentElement().firstChild().toElement(), stateDoc, QgsReadWriteContext() );
mLayout->project()->setDirty( true );
}
private:
QgsLayout *mLayout = nullptr;
};
///@endcond
QgsAbstractLayoutUndoCommand *QgsLayout::createCommand( const QString &text, int id, QUndoCommand *parent )
{
return new QgsLayoutUndoCommand( this, text, id, parent );
}
QgsLayoutItemGroup *QgsLayout::groupItems( const QList<QgsLayoutItem *> &items )
{
if ( items.size() < 2 )
{
//not enough items for a group
return nullptr;
}
mUndoStack->beginMacro( tr( "Group Items" ) );
std::unique_ptr< QgsLayoutItemGroup > itemGroup( new QgsLayoutItemGroup( this ) );
for ( QgsLayoutItem *item : items )
{
itemGroup->addItem( item );
}
QgsLayoutItemGroup *returnGroup = itemGroup.get();
addLayoutItem( itemGroup.release() );
std::unique_ptr< QgsLayoutItemGroupUndoCommand > c( new QgsLayoutItemGroupUndoCommand( QgsLayoutItemGroupUndoCommand::Grouped, returnGroup, this, tr( "Group Items" ) ) );
mUndoStack->push( c.release() );
mProject->setDirty( true );
#if 0
emit composerItemGroupAdded( itemGroup );
#endif
mUndoStack->endMacro();
return returnGroup;
}
QList<QgsLayoutItem *> QgsLayout::ungroupItems( QgsLayoutItemGroup *group )
{
QList<QgsLayoutItem *> ungroupedItems;
if ( !group )
{
return ungroupedItems;
}
mUndoStack->beginMacro( tr( "Ungroup Items" ) );
// Call this before removing group items so it can keep note
// of contents
std::unique_ptr< QgsLayoutItemGroupUndoCommand > c( new QgsLayoutItemGroupUndoCommand( QgsLayoutItemGroupUndoCommand::Ungrouped, group, this, tr( "Ungroup Items" ) ) );
mUndoStack->push( c.release() );
mProject->setDirty( true );
ungroupedItems = group->items();
group->removeItems();
removeLayoutItem( group );
mUndoStack->endMacro();
#if 0 //TODO
removeComposerItem( group, false, false );
#endif
return ungroupedItems;
}
void QgsLayout::refresh()
{
emit refreshed();
update();
}
void QgsLayout::writeXmlLayoutSettings( QDomElement &element, QDomDocument &document, const QgsReadWriteContext & ) const
{
mCustomProperties.writeXml( element, document );
element.setAttribute( QStringLiteral( "name" ), mName );
element.setAttribute( QStringLiteral( "units" ), QgsUnitTypes::encodeUnit( mUnits ) );
}
QDomElement QgsLayout::writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const
{
QDomElement element = document.createElement( QStringLiteral( "Layout" ) );
auto save = [&]( const QgsLayoutSerializableObject * object )->bool
{
return object->writeXml( element, document, context );
};
save( &mSnapper );
save( &mGridSettings );
save( mPageCollection.get() );
//save items except paper items and frame items (they are saved with the corresponding multiframe)
const QList<QGraphicsItem *> itemList = items();
for ( const QGraphicsItem *graphicsItem : itemList )
{
if ( const QgsLayoutItem *item = dynamic_cast< const QgsLayoutItem *>( graphicsItem ) )
{
if ( item->type() == QgsLayoutItemRegistry::LayoutPage
|| item->type() == QgsLayoutItemRegistry::LayoutFrame )
continue;
item->writeXml( element, document, context );
}
}
//save multiframes
for ( QgsLayoutMultiFrame *mf : mMultiFrames )
{
mf->writeXml( element, document, context );
}
writeXmlLayoutSettings( element, document, context );
return element;
}
bool QgsLayout::readXmlLayoutSettings( const QDomElement &layoutElement, const QDomDocument &, const QgsReadWriteContext & )
{
mCustomProperties.readXml( layoutElement );
setName( layoutElement.attribute( QStringLiteral( "name" ) ) );
setUnits( QgsUnitTypes::decodeLayoutUnit( layoutElement.attribute( QStringLiteral( "units" ) ) ) );
return true;
}
void QgsLayout::addLayoutItemPrivate( QgsLayoutItem *item )
{
addItem( item );
updateBounds();
mItemsModel->rebuildZList();
}
void QgsLayout::removeLayoutItemPrivate( QgsLayoutItem *item )
{
mItemsModel->setItemRemoved( item );
// small chance that item is still in a scene - the model may have
// rejected the removal for some reason. This is probably not necessary,
// but can't hurt...
if ( item->scene() )
removeItem( item );
#if 0 //TODO
emit itemRemoved( item );
#endif
delete item;
}
void QgsLayout::deleteAndRemoveMultiFrames()
{
qDeleteAll( mMultiFrames );
mMultiFrames.clear();
}
QPointF QgsLayout::minPointFromXml( const QDomElement &elem ) const
{
double minX = std::numeric_limits<double>::max();
double minY = std::numeric_limits<double>::max();
const QDomNodeList itemList = elem.elementsByTagName( QStringLiteral( "LayoutItem" ) );
bool found = false;
for ( int i = 0; i < itemList.size(); ++i )
{
const QDomElement currentItemElem = itemList.at( i ).toElement();
QgsLayoutPoint pos = QgsLayoutPoint::decodePoint( currentItemElem.attribute( QStringLiteral( "position" ) ) );
QPointF layoutPoint = convertToLayoutUnits( pos );
minX = std::min( minX, layoutPoint.x() );
minY = std::min( minY, layoutPoint.y() );
found = true;
}
return found ? QPointF( minX, minY ) : QPointF( 0, 0 );
}
void QgsLayout::updateZValues( const bool addUndoCommands )
{
int counter = mItemsModel->zOrderListSize();
const QList<QgsLayoutItem *> zOrderList = mItemsModel->zOrderList();
if ( addUndoCommands )
{
mUndoStack->beginMacro( tr( "Change Item Stacking" ) );
}
for ( QgsLayoutItem *currentItem : zOrderList )
{
if ( currentItem )
{
if ( addUndoCommands )
{
mUndoStack->beginCommand( currentItem, QString() );
}
currentItem->setZValue( counter );
if ( addUndoCommands )
{
mUndoStack->endCommand();
}
}
--counter;
}
if ( addUndoCommands )
{
mUndoStack->endMacro();
}
}
bool QgsLayout::readXml( const QDomElement &layoutElement, const QDomDocument &document, const QgsReadWriteContext &context )
{
if ( layoutElement.nodeName() != QStringLiteral( "Layout" ) )
{
return false;
}
auto restore = [&]( QgsLayoutSerializableObject * object )->bool
{
return object->readXml( layoutElement, document, context );
};
readXmlLayoutSettings( layoutElement, document, context );
restore( mPageCollection.get() );
restore( &mSnapper );
restore( &mGridSettings );
addItemsFromXml( layoutElement, document, context );
return true;
}
QList< QgsLayoutItem * > QgsLayout::addItemsFromXml( const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context, QPointF *position, bool pasteInPlace )
{
std::unique_ptr< QPointF > pasteInPlacePt;
QList< QgsLayoutItem * > newItems;
QList< QgsLayoutMultiFrame * > newMultiFrames;
//if we are adding items to a layout which already contains items, we need to make sure
//these items are placed at the top of the layout and that zValues are not duplicated
//so, calculate an offset which needs to be added to the zValue of created items
int zOrderOffset = mItemsModel->zOrderListSize();
QPointF pasteShiftPos;
if ( position )
{
//If we are placing items relative to a certain point, then calculate how much we need
//to shift the items by so that they are placed at this point
//First, calculate the minimum position from the xml
QPointF minItemPos = minPointFromXml( parentElement );
//next, calculate how much each item needs to be shifted from its original position
//so that it's placed at the correct relative position
pasteShiftPos = *position - minItemPos;
#if 0 // TODO - move to gui
//since we are pasting items, clear the existing selection
setAllDeselected();
#endif
if ( pasteInPlace )
{
int pageNumber = mPageCollection->pageNumberForPoint( *position );
pasteInPlacePt = qgis::make_unique< QPointF >( 0, mPageCollection->page( pageNumber )->pos().y() );
}
}
const QDomNodeList layoutItemList = parentElement.elementsByTagName( QStringLiteral( "LayoutItem" ) );
for ( int i = 0; i < layoutItemList.size(); ++i )
{
const QDomElement currentItemElem = layoutItemList.at( i ).toElement();
const int itemType = currentItemElem.attribute( QStringLiteral( "type" ) ).toInt();
std::unique_ptr< QgsLayoutItem > item( QgsApplication::layoutItemRegistry()->createItem( itemType, this ) );
if ( !item )
{
// e.g. plugin based item which is no longer available
continue;
}
item->readXml( currentItemElem, document, context );
if ( position )
{
#if 0 //TODO
if ( pasteInPlacePt )
{
item->setItemPosition( newLabel->pos().x(), std::fmod( newLabel->pos().y(), ( paperHeight() + spaceBetweenPages() ) ) );
item->move( pasteInPlacePt->x(), pasteInPlacePt->y() );
}
else
{
item->move( pasteShiftPos.x(), pasteShiftPos.y() );
}
#endif
}
#if 0 //TODO - move to gui
newLabel->setSelected( true );
#endif
QgsLayoutItem *layoutItem = item.get();
addLayoutItem( item.release() );
layoutItem->setZValue( layoutItem->zValue() + zOrderOffset );
newItems << layoutItem;
}
// multiframes
//TODO - fix this. pasting multiframe frame items has no effect
const QDomNodeList multiFrameList = parentElement.elementsByTagName( QStringLiteral( "LayoutMultiFrame" ) );
for ( int i = 0; i < multiFrameList.size(); ++i )
{
const QDomElement multiFrameElem = multiFrameList.at( i ).toElement();
const int itemType = multiFrameElem.attribute( QStringLiteral( "type" ) ).toInt();
std::unique_ptr< QgsLayoutMultiFrame > mf( QgsApplication::layoutItemRegistry()->createMultiFrame( itemType, this ) );
if ( !mf )
{
// e.g. plugin based item which is no longer available
continue;
}
mf->readXml( multiFrameElem, document, context );
#if 0 //TODO?
mf->setCreateUndoCommands( true );
#endif
QgsLayoutMultiFrame *m = mf.get();
this->addMultiFrame( mf.release() );
//offset z values for frames
//TODO - fix this after fixing multiframe item paste
/*for ( int frameIdx = 0; frameIdx < mf->frameCount(); ++frameIdx )
{
QgsLayoutItemFrame * frame = mf->frame( frameIdx );
frame->setZValue( frame->zValue() + zOrderOffset );
}*/
newMultiFrames << m;
}
// we now allow items to "post-process", e.g. if they need to setup connections
// to other items in the layout, which may not have existed at the time the
// item's state was restored. E.g. a scalebar may have been restored before the map
// it is linked to
for ( QgsLayoutItem *item : qgis::as_const( newItems ) )
{
item->finalizeRestoreFromXml();
}
for ( QgsLayoutMultiFrame *mf : qgis::as_const( newMultiFrames ) )
{
mf->finalizeRestoreFromXml();
}
//Since this function adds items in an order which isn't the z-order, and each item is added to end of
//z order list in turn, it will now be inconsistent with the actual order of items in the scene.
//Make sure z order list matches the actual order of items in the scene.
mItemsModel->rebuildZList();
return newItems;
}
void QgsLayout::updateBounds()
{
setSceneRect( layoutBounds( false, 0.05 ) );
}