-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsabstractreportsection.cpp
419 lines (355 loc) · 11.6 KB
/
qgsabstractreportsection.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
/***************************************************************************
qgsabstractreportsection.cpp
--------------------
begin : December 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 "qgsabstractreportsection.h"
#include "qgslayout.h"
#include "qgsreport.h"
#include "qgsreportsectionfieldgroup.h"
#include "qgsreportsectionlayout.h"
///@cond NOT_STABLE
QgsAbstractReportSection::QgsAbstractReportSection( QgsAbstractReportSection *parent )
: mParent( parent )
{}
QgsAbstractReportSection::~QgsAbstractReportSection()
{
qDeleteAll( mChildren );
}
QgsProject *QgsAbstractReportSection::project()
{
if ( QgsReport *report = dynamic_cast< QgsReport * >( this ) )
return report->layoutProject();
QgsAbstractReportSection *current = this;
while ( QgsAbstractReportSection *parent = current->parentSection() )
{
if ( !parent )
return nullptr;
if ( QgsReport *report = dynamic_cast< QgsReport * >( parent ) )
return report->layoutProject();
current = parent;
}
return nullptr;
}
void QgsAbstractReportSection::setContext( const QgsReportSectionContext &context )
{
auto setReportContext = [&context]( QgsLayout * layout )
{
if ( context.currentLayer )
{
layout->reportContext().blockSignals( true );
layout->reportContext().setLayer( context.currentLayer );
layout->reportContext().blockSignals( false );
}
layout->reportContext().setFeature( context.feature );
};
mContext = context;
if ( mHeader )
setReportContext( mHeader.get() );
if ( mFooter )
setReportContext( mFooter.get() );
for ( QgsAbstractReportSection *section : qgis::as_const( mChildren ) )
{
section->setContext( mContext );
}
}
bool QgsAbstractReportSection::writeXml( QDomElement &parentElement, QDomDocument &doc, const QgsReadWriteContext &context ) const
{
QDomElement element = doc.createElement( QStringLiteral( "Section" ) );
element.setAttribute( QStringLiteral( "type" ), type() );
element.setAttribute( QStringLiteral( "headerEnabled" ), mHeaderEnabled ? "1" : "0" );
if ( mHeader )
{
QDomElement headerElement = doc.createElement( QStringLiteral( "header" ) );
headerElement.appendChild( mHeader->writeXml( doc, context ) );
element.appendChild( headerElement );
}
element.setAttribute( QStringLiteral( "footerEnabled" ), mFooterEnabled ? "1" : "0" );
if ( mFooter )
{
QDomElement footerElement = doc.createElement( QStringLiteral( "footer" ) );
footerElement.appendChild( mFooter->writeXml( doc, context ) );
element.appendChild( footerElement );
}
for ( QgsAbstractReportSection *section : mChildren )
{
section->writeXml( element, doc, context );
}
writePropertiesToElement( element, doc, context );
parentElement.appendChild( element );
return true;
}
bool QgsAbstractReportSection::readXml( const QDomElement &element, const QDomDocument &doc, const QgsReadWriteContext &context )
{
if ( element.nodeName() != QStringLiteral( "Section" ) )
{
return false;
}
mHeaderEnabled = element.attribute( QStringLiteral( "headerEnabled" ), "0" ).toInt();
mFooterEnabled = element.attribute( QStringLiteral( "footerEnabled" ), "0" ).toInt();
const QDomElement headerElement = element.firstChildElement( QStringLiteral( "header" ) );
if ( !headerElement.isNull() )
{
const QDomElement headerLayoutElem = headerElement.firstChild().toElement();
std::unique_ptr< QgsLayout > header = qgis::make_unique< QgsLayout >( project() );
header->readXml( headerLayoutElem, doc, context );
mHeader = std::move( header );
}
const QDomElement footerElement = element.firstChildElement( QStringLiteral( "footer" ) );
if ( !footerElement.isNull() )
{
const QDomElement footerLayoutElem = footerElement.firstChild().toElement();
std::unique_ptr< QgsLayout > footer = qgis::make_unique< QgsLayout >( project() );
footer->readXml( footerLayoutElem, doc, context );
mFooter = std::move( footer );
}
const QDomNodeList sectionItemList = element.childNodes();
for ( int i = 0; i < sectionItemList.size(); ++i )
{
const QDomElement currentSectionElem = sectionItemList.at( i ).toElement();
if ( currentSectionElem.nodeName() != QStringLiteral( "Section" ) )
continue;
const QString sectionType = currentSectionElem.attribute( QStringLiteral( "type" ) );
//TODO - eventually move this to a registry when there's enough subclasses to warrant it
std::unique_ptr< QgsAbstractReportSection > section;
if ( sectionType == QLatin1String( "SectionFieldGroup" ) )
{
section = qgis::make_unique< QgsReportSectionFieldGroup >();
}
else if ( sectionType == QLatin1String( "SectionLayout" ) )
{
section = qgis::make_unique< QgsReportSectionLayout >();
}
if ( section )
{
appendChild( section.get() );
section->readXml( currentSectionElem, doc, context );
( void )section.release(); //ownership was transferred already
}
}
bool result = readPropertiesFromElement( element, doc, context );
return result;
}
QString QgsAbstractReportSection::filePath( const QString &baseFilePath, const QString &extension )
{
QString base = QStringLiteral( "%1_%2" ).arg( baseFilePath ).arg( mSectionNumber, 4, 10, QChar( '0' ) );
if ( !extension.startsWith( '.' ) )
base += '.';
base += extension;
return base;
}
QgsLayout *QgsAbstractReportSection::layout()
{
return mCurrentLayout;
}
bool QgsAbstractReportSection::beginRender()
{
// reset this section
reset();
mSectionNumber = 0;
// and all children too
bool result = true;
for ( QgsAbstractReportSection *child : qgis::as_const( mChildren ) )
{
result = result && child->beginRender();
}
return result;
}
bool QgsAbstractReportSection::next()
{
mSectionNumber++;
switch ( mNextSection )
{
case Header:
{
// regardless of whether we have a header or not, the next section will be the body
mNextSection = Body;
// if we have a header, then the current section will be the header
if ( mHeaderEnabled && mHeader )
{
prepareHeader();
mCurrentLayout = mHeader.get();
return true;
}
// but if not, then the current section is a body
mNextSection = Body;
FALLTHROUGH;
}
case Body:
{
mNextSection = Children;
bool ok = false;
// if we have a next body available, use it
QgsLayout *body = nextBody( ok );
if ( body )
{
mNextChild = 0;
mCurrentLayout = body;
return true;
}
FALLTHROUGH;
}
case Children:
{
bool bodiesAvailable = false;
do
{
// we iterate through all the section's children...
while ( mNextChild < mChildren.count() )
{
// ... staying on the current child only while it still has content for us
if ( mChildren.at( mNextChild )->next() )
{
mCurrentLayout = mChildren.at( mNextChild )->layout();
return true;
}
else
{
// no more content for this child, so move to next child
mNextChild++;
}
}
// used up all the children
// if we have a next body available, use it
QgsLayout *body = nextBody( bodiesAvailable );
if ( bodiesAvailable )
{
mNextChild = 0;
for ( QgsAbstractReportSection *section : qgis::as_const( mChildren ) )
{
section->reset();
}
}
if ( body )
{
mCurrentLayout = body;
return true;
}
}
while ( bodiesAvailable );
// all children and bodies have spent their content, so move to the footer
mNextSection = Footer;
FALLTHROUGH;
}
case Footer:
{
// regardless of whether we have a footer or not, this is the last section
mNextSection = End;
// if we have a footer, then the current section will be the footer
if ( mFooterEnabled && mFooter )
{
prepareFooter();
mCurrentLayout = mFooter.get();
return true;
}
// if not, then we're all done
FALLTHROUGH;
}
case End:
break;
}
mCurrentLayout = nullptr;
return false;
}
bool QgsAbstractReportSection::endRender()
{
// reset this section
reset();
// and all children too
bool result = true;
for ( QgsAbstractReportSection *child : qgis::as_const( mChildren ) )
{
result = result && child->endRender();
}
return result;
}
void QgsAbstractReportSection::reset()
{
mCurrentLayout = nullptr;
mNextChild = 0;
mNextSection = Header;
for ( QgsAbstractReportSection *section : qgis::as_const( mChildren ) )
{
section->reset();
}
}
void QgsAbstractReportSection::setHeader( QgsLayout *header )
{
mHeader.reset( header );
}
void QgsAbstractReportSection::setFooter( QgsLayout *footer )
{
mFooter.reset( footer );
}
int QgsAbstractReportSection::row() const
{
if ( mParent )
return mParent->childSections().indexOf( const_cast<QgsAbstractReportSection *>( this ) );
return 0;
}
QgsAbstractReportSection *QgsAbstractReportSection::childSection( int index )
{
return mChildren.value( index );
}
void QgsAbstractReportSection::appendChild( QgsAbstractReportSection *section )
{
section->setParentSection( this );
mChildren.append( section );
}
void QgsAbstractReportSection::insertChild( int index, QgsAbstractReportSection *section )
{
section->setParentSection( this );
index = std::max( 0, index );
index = std::min( index, mChildren.count() );
mChildren.insert( index, section );
}
void QgsAbstractReportSection::removeChild( QgsAbstractReportSection *section )
{
mChildren.removeAll( section );
delete section;
}
void QgsAbstractReportSection::removeChildAt( int index )
{
if ( index < 0 || index >= mChildren.count() )
return;
QgsAbstractReportSection *section = mChildren.at( index );
removeChild( section );
}
void QgsAbstractReportSection::copyCommonProperties( QgsAbstractReportSection *destination ) const
{
destination->mHeaderEnabled = mHeaderEnabled;
if ( mHeader )
destination->mHeader.reset( mHeader->clone() );
else
destination->mHeader.reset();
destination->mFooterEnabled = mFooterEnabled;
if ( mFooter )
destination->mFooter.reset( mFooter->clone() );
else
destination->mFooter.reset();
qDeleteAll( destination->mChildren );
destination->mChildren.clear();
for ( QgsAbstractReportSection *child : qgis::as_const( mChildren ) )
{
destination->appendChild( child->clone() );
}
}
bool QgsAbstractReportSection::writePropertiesToElement( QDomElement &, QDomDocument &, const QgsReadWriteContext & ) const
{
return true;
}
bool QgsAbstractReportSection::readPropertiesFromElement( const QDomElement &, const QDomDocument &, const QgsReadWriteContext & )
{
return true;
}
///@endcond