QGIS/python/core/auto_generated/layout/qgsprintlayout.sip.in
Nyall Dawson 590d1aae9d [FEATURE][API] Visitor API for style entities
Adds a new visitor pattern API for creation of visitors which visit
all the style entities (symbols, color ramps, text formats, and
label styles) associated with different objects. Can be used on a
renderer, map layer, or project wide level.

E.g. on a project wide level, allows collection of ALL the style
symbols/color ramps/text settings inside a project, including those
in layouts or annotations!
2019-07-06 12:36:54 +10:00

82 lines
2.5 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgsprintlayout.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsPrintLayout : QgsLayout, QgsMasterLayoutInterface
{
%Docstring
Print layout, a QgsLayout subclass for static or atlas-based layouts.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsprintlayout.h"
%End
public:
QgsPrintLayout( QgsProject *project );
%Docstring
Constructor for QgsPrintLayout.
%End
virtual QgsPrintLayout *clone() const /Factory/;
virtual QgsProject *layoutProject() const;
virtual QgsMasterLayoutInterface::Type layoutType() const;
virtual QIcon icon() const;
QgsLayoutAtlas *atlas();
%Docstring
Returns the print layout's atlas.
%End
virtual QString name() const;
virtual void setName( const QString &name );
virtual QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const;
virtual bool readXml( const QDomElement &layoutElement, const QDomDocument &document, const QgsReadWriteContext &context );
virtual QDomElement writeLayoutXml( QDomDocument &document, const QgsReadWriteContext &context ) const;
virtual bool readLayoutXml( const QDomElement &layoutElement, const QDomDocument &document, const QgsReadWriteContext &context );
virtual QgsExpressionContext createExpressionContext() const;
virtual void updateSettings();
virtual bool layoutAccept( QgsStyleEntityVisitorInterface *visitor ) const;
signals:
void nameChanged( const QString &name );
%Docstring
Emitted when the layout's name is changed.
.. seealso:: :py:func:`setName`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgsprintlayout.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/