Skip to content
Permalink
Browse files

Add warning note to QgsLayoutPageCollection::shouldExportPage

  • Loading branch information
nyalldawson committed May 28, 2018
1 parent 5cf3396 commit e552ce62be25bfad3ae3a38020d59fbcea79becb
@@ -100,6 +100,11 @@ Returns a list of layout items on the specified ``page`` index.
%Docstring
Returns whether the specified ``page`` number should be included in exports of the layouts.

.. warning::

This will always return true unless the layout is being currently exported -- it cannot
be used in advance to determine whether a given page will be exported!

.. seealso:: :py:func:`pageIsEmpty`
%End

@@ -138,6 +138,10 @@ class CORE_EXPORT QgsLayoutPageCollection : public QObject, public QgsLayoutSeri

/**
* Returns whether the specified \a page number should be included in exports of the layouts.
*
* \warning This will always return true unless the layout is being currently exported -- it cannot
* be used in advance to determine whether a given page will be exported!
*
* \see pageIsEmpty()
*/
bool shouldExportPage( int page ) const;

0 comments on commit e552ce6

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