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 <QObject>
#include <QAbstractListModel>
#include <QSortFilterProxyModel>
 
class QgsProject;
class QgsPrintLayout;
class QgsStyleEntityVisitorInterface;
 
class CORE_EXPORT QgsLayoutManager : public QObject
{
    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 );
 
  private:
 
    QgsProject *mProject = nullptr;
 
    QList< QgsMasterLayoutInterface * > mLayouts;
 
};
 
 
class CORE_EXPORT QgsLayoutManagerModel : public QAbstractListModel
{
    Q_OBJECT
 
  public:
 
    // *INDENT-OFF*
 
    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsLayoutManagerModel, Role ) : int
    {
      Layout SIP_MONKEYPATCH_COMPAT_NAME(LayoutRole) = Qt::UserRole + 1, 
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    explicit QgsLayoutManagerModel( QgsLayoutManager *manager, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    int rowCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
 
    QgsMasterLayoutInterface *layoutFromIndex( const QModelIndex &index ) const;
 
    QModelIndex indexFromLayout( QgsMasterLayoutInterface *layout ) const;
 
    void setAllowEmptyLayout( bool allowEmpty );
 
    bool allowEmptyLayout() const { return mAllowEmpty; }
 
  private slots:
    void layoutAboutToBeAdded( const QString &name );
    void layoutAboutToBeRemoved( const QString &name );
    void layoutAdded( const QString &name );
    void layoutRemoved( const QString &name );
    void layoutRenamed( QgsMasterLayoutInterface *layout, const QString &newName );
  private:
    QgsLayoutManager *mLayoutManager = nullptr;
    bool mAllowEmpty = false;
};
 
 
class CORE_EXPORT QgsLayoutManagerProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
 
    enum Filter SIP_ENUM_BASETYPE( IntFlag )
    {
      FilterPrintLayouts = 1 << 1, 
      FilterReports = 1 << 2, 
    };
    Q_DECLARE_FLAGS( Filters, Filter )
    Q_FLAG( Filters )
 
    
    explicit QgsLayoutManagerProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
 
    QgsLayoutManagerProxyModel::Filters filters() const;
 
    void setFilters( QgsLayoutManagerProxyModel::Filters filters );
 
    QString filterString() const { return mFilterString; }
 
  public slots:
 
    void setFilterString( const QString &filter );
 
  private:
 
    Filters mFilters = Filters( FilterPrintLayouts | FilterReports );
 
    QString mFilterString;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsLayoutManagerProxyModel::Filters )
 
#endif // QGSLAYOUTMANAGER_H