Skip to content
Permalink
Browse files

Fix outdated docs

Fixes #19004
  • Loading branch information
nyalldawson committed May 22, 2018
1 parent 2bbea0d commit f82b639604a78ad4b0c591bf18bb272608eebda9
Showing with 15 additions and 13 deletions.
  1. +6 −7 python/core/auto_generated/layout/qgslayoutatlas.sip.in
  2. +9 −6 src/core/layout/qgslayoutatlas.h
@@ -11,15 +11,14 @@
class QgsLayoutAtlas : QObject, QgsAbstractLayoutIterator, QgsLayoutSerializableObject
{
%Docstring
Class used to render an Atlas, iterating over geometry features.
prepareForFeature() modifies the atlas map's extent to zoom on the given feature.
This class is used for printing, exporting to PDF and images.
Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector layer.

.. note::
QgsLayoutAtlas implement the QgsAbstractLayoutIterator interface, allowing them to be used
directly with QgsLayoutExporter to automatically output all pages from the atlas.

This class should not be created directly. For the atlas to function correctly
the atlasComposition() property for QgsComposition should be used to retrieve a
QgsLayoutAtlas which is automatically created and attached to the composition.
For QgsPrintLayout layouts, it is not necessary to manually construct a
QgsLayoutAtlas object. Instead, the atlas attached to the print layout
should be used. This can be retrieved by calling :py:func:`QgsPrintLayout.atlas()`

.. versionadded:: 3.0
%End
@@ -26,12 +26,15 @@ class QgsLayout;

/**
* \ingroup core
* Class used to render an Atlas, iterating over geometry features.
* prepareForFeature() modifies the atlas map's extent to zoom on the given feature.
* This class is used for printing, exporting to PDF and images.
* \note This class should not be created directly. For the atlas to function correctly
* the atlasComposition() property for QgsComposition should be used to retrieve a
* QgsLayoutAtlas which is automatically created and attached to the composition.
* Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector layer.
*
* QgsLayoutAtlas implement the QgsAbstractLayoutIterator interface, allowing them to be used
* directly with QgsLayoutExporter to automatically output all pages from the atlas.
*
* For QgsPrintLayout layouts, it is not necessary to manually construct a
* QgsLayoutAtlas object. Instead, the atlas attached to the print layout
* should be used. This can be retrieved by calling QgsPrintLayout::atlas().
*
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutAtlas : public QObject, public QgsAbstractLayoutIterator, public QgsLayoutSerializableObject

0 comments on commit f82b639

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