sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-17 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

[layout] Disable ref images generation and added docs

Browse Source
This commit is contained in:
Alessandro Pasotti 2017-12-19 12:24:28 +01:00
parent dd0cce23cd
commit 51a460775f
2 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/core/layout/qgscompositionconverter.h
View File

@ -16,11 +16,15 @@
#ifndef QGSCOMPOSITIONCONVERTER_H
#define QGSCOMPOSITIONCONVERTER_H
#include <QDomDocument>
#include <QDomElement>
#include "qgis.h"
#include "qgis_sip.h"
#define SIP_NO_FILE
#include "qgspropertycollection.h"
class QgsLayout;
@ -38,6 +42,13 @@ class QgsLayoutItemMap;
class QgsLayoutItemScaleBar;
class QgsLayoutItemLegend;
/**
* QgsCompositionConverter class converts a QGIS 2.x composition to a QGIS 3.x layout
* \since QGIS 3.0
* \note Not available in Python bindings.
* \ingroup core
*/
class CORE_EXPORT QgsCompositionConverter
{
public:
@ -97,7 +108,7 @@ class CORE_EXPORT QgsCompositionConverter
};
/**
* The MarkerMode enum is the old 2.x arrow marker mode
* The MarkerMode enum is the old QGIS 2.x arrow marker mode
*/
enum MarkerMode
{
@ -109,16 +120,28 @@ class CORE_EXPORT QgsCompositionConverter
/**
* \brief createLayoutFromCompositionXml is a factory that creates layout instances from a
* QGIS 2.x XML composition \a document
* QGIS 2.x XML composition \a document
* \param parentElement is the Composition element
* \param document
* \param context
* \param project the QGIS project
* \return a QgsLayout instance
* \since QGIS 3.0
* \note Not available in Python bindings.
*/
static QgsLayout *createLayoutFromCompositionXml( const QDomElement &parentElement,
QgsProject *project ) SIP_FACTORY;
/**
* addItemsFromCompositionXml parse a QGIS 2.x composition XML in the \a parentElement,
* converts the 2.x items to the new layout elements and add them to the \a layout
* \param layout the lay
* \param parentElement
* \param position for pasting
* \param pasteInPlace if true element position is translated to \a position
* \return a list of layout items
* \since QGIS 3.0
* \note Not available in Python bindings.
*/
static QList<QgsLayoutItem *> addItemsFromCompositionXml( QgsLayout *layout,
const QDomElement &parentElement,
QPointF *position = nullptr,

2
tests/src/core/testqgscompositionconverter.cpp
View File

@ -402,7 +402,7 @@ void TestQgsCompositionConverter::checkRenderedImage( QgsLayout *layout, const Q
QSize size( layout->pageCollection()->page( pageNumber )->sizeWithUnits().width() * 3.77, layout->pageCollection()->page( pageNumber )->sizeWithUnits().height() * 3.77 );
checker.setSize( size );
checker.setControlPathPrefix( QStringLiteral( "compositionconverter" ) );
QVERIFY( checker.testLayout( mReport, pageNumber, 0, true ) );
QVERIFY( checker.testLayout( mReport, pageNumber ) );
}
void TestQgsCompositionConverter::exportLayout( QgsLayout *layout, const QString testName )