qgslayoutmanager.h

Go to the documentation of this file.

/***************************************************************************
    qgslayoutmanager.h
    ------------------
    Date                 : January 2017
    Copyright            : (C) 2017 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 QGSLAYOUTMANAGER_H
#define QGSLAYOUTMANAGER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmasterlayoutinterface.h"
#include "qgsprojectstoredobjectmanager.h"
 
#include <QAbstractListModel>
#include <QObject>
#include <QSortFilterProxyModel>
 
class QgsProject;
class QgsPrintLayout;
class QgsStyleEntityVisitorInterface;

#ifdef SIP_RUN
class CORE_EXPORT QgsLayoutManager : public QgsProjectStoredObjectManagerBase // for sip we skip to the base class and avoid the template difficulty
{
#else
class CORE_EXPORT QgsLayoutManager : public QgsAbstractProjectStoredObjectManager< QgsMasterLayoutInterface >
{
#endif
    Q_OBJECT
 
  public:
    explicit QgsLayoutManager( QgsProject *project SIP_TRANSFERTHIS = nullptr );
 
    ~QgsLayoutManager() override;

    bool addLayout( QgsMasterLayoutInterface *layout SIP_TRANSFER );

    bool removeLayout( QgsMasterLayoutInterface *layout );

    void clear();

    QList< QgsMasterLayoutInterface * > layouts() const;

    QList< QgsPrintLayout * > printLayouts() const;

    QgsMasterLayoutInterface *layoutByName( const QString &name ) const;

    bool readXml( const QDomElement &element, const QDomDocument &doc );

    QDomElement writeXml( QDomDocument &doc ) const;

    QgsMasterLayoutInterface *duplicateLayout( const QgsMasterLayoutInterface *layout, const QString &newName );

    QString generateUniqueTitle( QgsMasterLayoutInterface::Type type = QgsMasterLayoutInterface::PrintLayout ) const;

    bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
 
  signals:

    void layoutAboutToBeAdded( const QString &name );

    void layoutAdded( const QString &name );

    void layoutRemoved( const QString &name );

    void layoutAboutToBeRemoved( const QString &name );

    void layoutRenamed( QgsMasterLayoutInterface *layout, const QString &newName );
 
  protected:
    void setupObjectConnections( QgsMasterLayoutInterface *layout ) override;
 
  private:
};
 
 
#endif // QGSLAYOUTMANAGER_H