qgslayoutmanagermodel.h

Go to the documentation of this file.

/***************************************************************************
    qgslayoutmanagermodel.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 QGSLAYOUTMANAGERMODEL_H
#define QGSLAYOUTMANAGERMODEL_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsprojectstoredobjectmanagermodel.h"
 
#include <QAbstractListModel>
#include <QObject>
#include <QSortFilterProxyModel>
 
class QgsProject;
class QgsPrintLayout;
class QgsStyleEntityVisitorInterface;
class QgsLayoutManager;
class QgsMasterLayoutInterface;
 

#ifdef SIP_RUN
class CORE_EXPORT QgsLayoutManagerModel : public QgsProjectStoredObjectManagerModelBase // for sip we skip to the base class and avoid the template difficulty
{
#else
class CORE_EXPORT QgsLayoutManagerModel : public QgsProjectStoredObjectManagerModel< QgsMasterLayoutInterface >
{
#endif
    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 );

    QgsMasterLayoutInterface *layoutFromIndex( const QModelIndex &index ) const;

    QModelIndex indexFromLayout( QgsMasterLayoutInterface *layout ) const;

    void setAllowEmptyLayout( bool allowEmpty );

    bool allowEmptyLayout() const { return allowEmptyObject(); }
 
};
 

#ifdef SIP_RUN
class CORE_EXPORT QgsLayoutManagerProxyModel : public QgsProjectStoredObjectManagerProxyModelBase // for sip we skip to the base class and avoid the template difficulty
{
#else
class CORE_EXPORT QgsLayoutManagerProxyModel : public QgsProjectStoredObjectManagerProxyModel< QgsMasterLayoutInterface >
{
#endif
    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 );

    QgsLayoutManagerProxyModel::Filters filters() const;

    void setFilters( QgsLayoutManagerProxyModel::Filters filters );
 
  protected:
 
    bool filterAcceptsRowInternal( int sourceRow, const QModelIndex &sourceParent ) const override;
 
  private:
 
    Filters mFilters = Filters( FilterPrintLayouts | FilterReports );
 
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsLayoutManagerProxyModel::Filters )
#endif // QGSLAYOUTMANAGERMODEL_H