qgslayoutmodel.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutmodel.h
                         ----------------
    begin                : October 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 QGSLAYOUTMODEL_H
#define QGSLAYOUTMODEL_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayoutitemregistry.h"

#include <QAbstractItemModel>
#include <QSortFilterProxyModel>
#include <QStringList>
#include <QSet>

class QgsLayout;
class QGraphicsItem;
class QgsLayoutItem;

class CORE_EXPORT QgsLayoutModel: public QAbstractItemModel
{
    Q_OBJECT

  public:

    enum Columns
    {
      Visibility = 0, 
      LockStatus, 
      ItemId, 
    };

    explicit QgsLayoutModel( QgsLayout *layout, QObject *parent SIP_TRANSFERTHIS = nullptr );

    //reimplemented QAbstractItemModel methods
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
    Qt::DropActions supportedDropActions() const override;
    QStringList mimeTypes() const override;
    QMimeData *mimeData( const QModelIndexList &indexes ) const override;
    bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) override;
    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;

#ifndef SIP_RUN

    void clear();

    int zOrderListSize() const;

    void rebuildZList();

    void addItemAtTop( QgsLayoutItem *item );

    void removeItem( QgsLayoutItem *item );

    bool reorderItemUp( QgsLayoutItem *item );

    bool reorderItemDown( QgsLayoutItem *item );

    bool reorderItemToTop( QgsLayoutItem *item );

    bool reorderItemToBottom( QgsLayoutItem *item );

    QgsLayoutItem *findItemAbove( QgsLayoutItem *item ) const;

    QgsLayoutItem *findItemBelow( QgsLayoutItem *item ) const;

    QList<QgsLayoutItem *> &zOrderList();

    void setItemRemoved( QgsLayoutItem *item );

#if 0

    void setItemRestored( QgsComposerItem *item );
#endif

    void updateItemDisplayName( QgsLayoutItem *item );

    void updateItemLockStatus( QgsLayoutItem *item );

    void updateItemVisibility( QgsLayoutItem *item );

    void updateItemSelectStatus( QgsLayoutItem *item );
#endif

    QgsLayoutItem *itemFromIndex( const QModelIndex &index ) const;

    QModelIndex indexForItem( QgsLayoutItem *item, int column = 0 );

  public slots:

#ifndef SIP_RUN

    void setSelected( const QModelIndex &index );
#endif

  private:

    QList<QgsLayoutItem *> mItemZList;

    QList<QgsLayoutItem *> mItemsInScene;

    QgsLayout *mLayout = nullptr;

    void refreshItemsInScene();

    void rebuildSceneItemList();

    friend class TestQgsLayoutModel;
    friend class TestQgsLayoutGui;
};


class CORE_EXPORT QgsLayoutProxyModel: public QSortFilterProxyModel
{
    Q_OBJECT

  public:

    QgsLayoutProxyModel( QgsLayout *layout, QObject *parent SIP_TRANSFERTHIS = nullptr );

    QgsLayoutItemRegistry::ItemType filterType() const { return mItemTypeFilter; }

    void setFilterType( QgsLayoutItemRegistry::ItemType filter );

    void setExceptedItemList( const QList< QgsLayoutItem * > &items );

    QList< QgsLayoutItem * > exceptedItemList() const { return mExceptedList; }

    QgsLayoutModel *sourceLayerModel() const { return static_cast< QgsLayoutModel * >( sourceModel() ); }

    QgsLayoutItem *itemFromSourceIndex( const QModelIndex &sourceIndex ) const;

    QgsLayout *layout() { return mLayout; }

    void setAllowEmptyItem( bool allowEmpty );

    bool allowEmptyItem() const;

  protected:
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;

  private:
    QgsLayout *mLayout = nullptr;
    QgsLayoutItemRegistry::ItemType mItemTypeFilter;
    QList< QgsLayoutItem * > mExceptedList;
    bool mAllowEmpty = false;

};



#endif //QGSLAYOUTMODEL_H