Skip to content
Permalink
Browse files

[layout] Disable ref images generation and added docs

  • Loading branch information
elpaso committed Dec 19, 2017
1 parent dd0cce2 commit 51a460775fe7299d1998eeeeb59a654e79b48509
Showing with 29 additions and 6 deletions.
  1. +28 −5 src/core/layout/qgscompositionconverter.h
  2. +1 −1 tests/src/core/testqgscompositionconverter.cpp
@@ -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,
@@ -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 )

0 comments on commit 51a4607

Please sign in to comment.
You can’t perform that action at this time.