qgslayoutpagecollection.h

Go to the documentation of this file.

/***************************************************************************
                              qgslayoutpagecollection.h
                             --------------------------
    begin                : July 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSLAYOUTPAGECOLLECTION_H
#define QGSLAYOUTPAGECOLLECTION_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssymbol.h"
#include "qgslayout.h"
#include "qgslayoutitempage.h"
#include "qgslayoutitem.h"
#include "qgslayoutserializableobject.h"
#include "qgslayoutpoint.h"
#include <QObject>
#include <memory>

class QgsLayout;
class QgsLayoutGuideCollection;

class CORE_EXPORT QgsLayoutPageCollection : public QObject, public QgsLayoutSerializableObject
{

    Q_OBJECT

  public:

    explicit QgsLayoutPageCollection( QgsLayout *layout SIP_TRANSFERTHIS );

    ~QgsLayoutPageCollection() override;

    QString stringType() const override { return QStringLiteral( "LayoutPageCollection" ); }
    QgsLayout *layout() override;

    QList< QgsLayoutItemPage * > pages();

    int pageCount() const;

    QgsLayoutItemPage *page( int pageNumber );

    const QgsLayoutItemPage *page( int pageNumber ) const SIP_SKIP;

    int pageNumber( QgsLayoutItemPage *page ) const;

    QList< QgsLayoutItemPage * > visiblePages( const QRectF &region ) const;

    QList< int > visiblePageNumbers( const QRectF &region ) const;

    bool pageIsEmpty( int page ) const;

    QList< QgsLayoutItem *> itemsOnPage( int page ) const;

    template<class T> void itemsOnPage( QList<T *> &itemList, int page ) const SIP_SKIP
    {
      itemList.clear();
      const QList<QGraphicsItem *> graphicsItemList = mLayout->items();
      for ( QGraphicsItem *graphicsItem : graphicsItemList )
      {
        T *item = dynamic_cast<T *>( graphicsItem );
        if ( item && item->page() == page )
        {
          itemList.push_back( item );
        }
      }
    }

    bool shouldExportPage( int page ) const;

    void addPage( QgsLayoutItemPage *page SIP_TRANSFER );

    QgsLayoutItemPage *extendByNewPage();

    void insertPage( QgsLayoutItemPage *page SIP_TRANSFER, int beforePage );

    void deletePage( int pageNumber );

    void deletePage( QgsLayoutItemPage *page );

    void clear();

    QgsLayoutItemPage *takePage( QgsLayoutItemPage *page ) SIP_TRANSFERBACK;

    void setPageStyleSymbol( QgsFillSymbol *symbol );

    Q_DECL_DEPRECATED const QgsFillSymbol *pageStyleSymbol() const SIP_DEPRECATED;

    void beginPageSizeChange();

    void endPageSizeChange();

    void reflow();

    double maximumPageWidth() const;

    QSizeF maximumPageSize() const;

    bool hasUniformPageSizes() const;

    int pageNumberForPoint( QPointF point ) const;

    int predictPageNumberForPoint( QPointF point ) const;

    QgsLayoutItemPage *pageAtPoint( QPointF point ) const;

    QPointF pagePositionToLayoutPosition( int page, const QgsLayoutPoint &position ) const;

    QgsLayoutPoint pagePositionToAbsolute( int page, const QgsLayoutPoint &position ) const;

    QPointF positionOnPage( QPointF point ) const;

    double spaceBetweenPages() const;

    double pageShadowWidth() const;

    void resizeToContents( const QgsMargins &margins, QgsUnitTypes::LayoutUnit marginUnits );

    bool writeXml( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const override;

    bool readXml( const QDomElement &collectionElement, const QDomDocument &document, const QgsReadWriteContext &context ) override;

    QgsLayoutGuideCollection &guides();

    SIP_SKIP const QgsLayoutGuideCollection &guides() const;

  public slots:

    void redraw();

  signals:

    void changed();

    void pageAboutToBeRemoved( int pageNumber );

  private:

    QgsLayout *mLayout = nullptr;

    std::unique_ptr< QgsLayoutGuideCollection > mGuideCollection;

    std::unique_ptr< QgsFillSymbol > mPageStyleSymbol;

    QList< QgsLayoutItemPage * > mPages;

    bool mBlockUndoCommands = false;

    QMap< QString, QPair< int, QgsLayoutPoint > > mPreviousItemPositions;

    void createDefaultPageStyleSymbol();

    friend class QgsLayoutPageCollectionUndoCommand;
};

#endif //QGSLAYOUTPAGECOLLECTION_H