qgsmaplayermodel.h

Go to the documentation of this file.

/***************************************************************************
   qgsmaplayermodel.h
    --------------------------------------
   Date                 : 01.04.2014
   Copyright            : (C) 2014 Denis Rouzaud
   Email                : denis.rouzaud@gmail.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 QGSMAPLAYERMODEL_H
#define QGSMAPLAYERMODEL_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QAbstractItemModel>
#include <QIcon>
#include <QSortFilterProxyModel>
#include <QStringList>
 
class QgsMapLayer;
class QgsProject;

class CORE_EXPORT QgsMapLayerModel : public QAbstractItemModel
{
    Q_OBJECT
 
    Q_PROPERTY( bool allowEmptyLayer READ allowEmptyLayer WRITE setAllowEmptyLayer )
    Q_PROPERTY( bool showCrs READ showCrs WRITE setShowCrs )
    Q_PROPERTY( bool itemsCheckable READ itemsCheckable WRITE setItemsCheckable )
    Q_PROPERTY( QStringList additionalItems READ additionalItems WRITE setAdditionalItems )
 
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsMapLayerModel, ItemDataRole ) : int
    {
      LayerId SIP_MONKEYPATCH_COMPAT_NAME( LayerIdRole ) = Qt::UserRole + 1, 
      Layer SIP_MONKEYPATCH_COMPAT_NAME( LayerRole ),                        
      Empty SIP_MONKEYPATCH_COMPAT_NAME( EmptyRole ),                        
      Additional SIP_MONKEYPATCH_COMPAT_NAME( AdditionalRole ),              
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    // TODO QGIS 5.0 -- remove deprecated constructors
 
    
    explicit QgsMapLayerModel( QObject *parent SIP_TRANSFERTHIS = nullptr, QgsProject *project = nullptr ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED explicit QgsMapLayerModel( const QList<QgsMapLayer *> &layers, QObject *parent = nullptr, QgsProject *project = nullptr ) SIP_DEPRECATED;
 
    // TODO QGIS 5.0 -- drop SIP_SKIP from the following constructors, so that they are available in Python

    explicit QgsMapLayerModel( QgsProject *project, QObject *parent SIP_TRANSFERTHIS = nullptr ) SIP_SKIP;

    explicit QgsMapLayerModel( QgsProject *project, const QList<QgsMapLayer *> &layers, QObject *parent SIP_TRANSFERTHIS = nullptr ) SIP_SKIP;

    void setItemsCheckable( bool checkable );

    void setProject( QgsProject *project );

    QgsProject *project();

    void setItemsCanBeReordered( bool allow );

    bool itemsCanBeReordered() const;

    void checkAll( Qt::CheckState checkState );

    void setAllowEmptyLayer( bool allowEmpty, const QString &text = QString(), const QIcon &icon = QIcon() );

    bool allowEmptyLayer() const { return mAllowEmpty; }

    void setShowCrs( bool showCrs );

    bool showCrs() const { return mShowCrs; }

    QList<QgsMapLayer *> layersChecked( Qt::CheckState checkState = Qt::Checked );

    void setLayersChecked( const QList< QgsMapLayer * > &layers );

    bool itemsCheckable() const { return mItemCheckable; }

    QModelIndex indexFromLayer( QgsMapLayer *layer ) const;

    QgsMapLayer *layerFromIndex( const QModelIndex &index ) const;

    void setAdditionalItems( const QStringList &items );

    QStringList additionalItems() const { return mAdditionalItems; }

    void setAdditionalLayers( const QList<QgsMapLayer *> &layers );

    QList< QgsMapLayer * > additionalLayers() const;
 
    // QAbstractItemModel interface
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &child ) 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 = Qt::DisplayRole ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    bool insertRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
    QStringList mimeTypes() const override;
    bool canDropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) 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;
    Qt::DropActions supportedDropActions() const override;

    QHash<int, QByteArray> roleNames() const override SIP_SKIP;

    static QIcon iconForLayer( QgsMapLayer *layer );
 
  protected slots:
    void removeLayers( const QStringList &layerIds );
    void addLayers( const QList<QgsMapLayer *> &layers );
 
  protected:
    QList<QgsMapLayer *> mLayers;
    QList< QPointer<QgsMapLayer> > mAdditionalLayers;
    QMap<QString, Qt::CheckState> mLayersChecked;
    bool mItemCheckable = false;
    bool mCanReorder = false;
 
    QgsProject *mProject = nullptr;
 
  private:
    bool mAllowEmpty = false;
    QString mEmptyText;
    QIcon mEmptyIcon;
    bool mShowCrs = false;
    QStringList mAdditionalItems;
};
 
#endif // QGSMAPLAYERMODEL_H