qgscomposermodel.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposermodel.h
                         -----------------
    begin                : July 2014
    copyright            : (C) 2014 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 QGSCOMPOSERMODEL_H
#define QGSCOMPOSERMODEL_H

#include <QAbstractItemModel>
#include <QSortFilterProxyModel>
#include <QStringList>
#include <QSet>
#include "qgscomposeritem.h"

class QgsComposition;
class QGraphicsItem;

class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
{
    Q_OBJECT

  public:

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

    explicit QgsComposerModel( QgsComposition* composition, QObject* parent = nullptr );

    ~QgsComposerModel();

    //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;
    virtual QStringList mimeTypes() const override;
    virtual 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;

    void clear();

    int zOrderListSize() const;

    void rebuildZList();

    void addItemAtTop( QgsComposerItem *item );

    void removeItem( QgsComposerItem *item );

    bool reorderItemUp( QgsComposerItem *item );

    bool reorderItemDown( QgsComposerItem *item );

    bool reorderItemToTop( QgsComposerItem *item );

    bool reorderItemToBottom( QgsComposerItem *item );

    QgsComposerItem* getComposerItemAbove( QgsComposerItem *item ) const;

    QgsComposerItem* getComposerItemBelow( QgsComposerItem *item ) const;

    QList<QgsComposerItem *>* zOrderList();

    void setItemRemoved( QgsComposerItem *item );

    void setItemRestored( QgsComposerItem *item );

    void updateItemDisplayName( QgsComposerItem *item );

    void updateItemLockStatus( QgsComposerItem *item );

    void updateItemVisibility( QgsComposerItem *item );

    void updateItemSelectStatus( QgsComposerItem *item );

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

  public slots:

    void setSelected( const QModelIndex &index );

  protected:

    QList<QgsComposerItem*> mItemZList;

    QList<QgsComposerItem*> mItemsInScene;

  private:

    QgsComposition* mComposition;

    QgsComposerItem* itemFromIndex( const QModelIndex &index ) const;

    void refreshItemsInScene();

    void rebuildSceneItemList();

    friend class TestQgsComposerModel;
    friend class TestQgsComposerGui;
};


class CORE_EXPORT QgsComposerProxyModel: public QSortFilterProxyModel
{
    Q_OBJECT

  public:

    QgsComposerProxyModel( QgsComposition* composition, QObject *parent = nullptr );

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

    void setFilterType( QgsComposerItem::ItemType itemType );

    void setExceptedItemList( const QList< QgsComposerItem* >& exceptList );

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

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

    QgsComposerItem* itemFromSourceIndex( const QModelIndex& sourceIndex ) const;

  protected:
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;

  private:
    QgsComposition* mComposition;
    QgsComposerItem::ItemType mItemTypeFilter;
    QList< QgsComposerItem* > mExceptedList;

};



#endif //QGSCOMPOSERMODEL