qgsmaplayerstore.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmaplayerstore.h
                         ------------------
    begin                : May 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 QGSMAPLAYERSTORE_H
#define QGSMAPLAYERSTORE_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmaplayer.h"
#include <QObject>

class CORE_EXPORT QgsMapLayerStore : public QObject
{
    Q_OBJECT

  public:

    explicit QgsMapLayerStore( QObject *parent SIP_TRANSFERTHIS = nullptr );

    ~QgsMapLayerStore() override;

    int count() const;

    int validCount() const;

#ifdef SIP_RUN

    int __len__() const;
    % MethodCode
    sipRes = sipCpp->count();
    % End

    int __bool__() const;
    % MethodCode
    sipRes = true;
    % End
#endif

    QgsMapLayer *mapLayer( const QString &id ) const;

    QList<QgsMapLayer *> mapLayersByName( const QString &name ) const;

    QMap<QString, QgsMapLayer *> mapLayers() const;

    QMap<QString, QgsMapLayer *> validMapLayers() const;

#ifndef SIP_RUN

    template <typename T>
    QVector<T> layers() const
    {
      QVector<T> layers;
      QMap<QString, QgsMapLayer *>::const_iterator layerIt = mMapLayers.constBegin();
      for ( ; layerIt != mMapLayers.constEnd(); ++layerIt )
      {
        T tLayer = qobject_cast<T>( layerIt.value() );
        if ( tLayer )
        {
          layers << tLayer;
        }
      }
      return layers;
    }
#endif

    QList<QgsMapLayer *> addMapLayers( const QList<QgsMapLayer *> &layers SIP_TRANSFER,
                                       bool takeOwnership SIP_PYARGREMOVE = true );

    QgsMapLayer *addMapLayer( QgsMapLayer *layer SIP_TRANSFER,
                              bool takeOwnership SIP_PYARGREMOVE = true );

    void removeMapLayers( const QStringList &layerIds ) SIP_PYNAME( removeMapLayersById );

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

    void removeMapLayer( const QString &id );

    void removeMapLayer( QgsMapLayer *layer );

    QgsMapLayer *takeMapLayer( QgsMapLayer *layer ) SIP_TRANSFERBACK;

    void removeAllMapLayers();

    void transferLayersFromStore( QgsMapLayerStore *other );

  signals:

    void layersWillBeRemoved( const QStringList &layerIds );

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

    void layerWillBeRemoved( const QString &layerId );

    void layerWillBeRemoved( QgsMapLayer *layer );

    void layersRemoved( const QStringList &layerIds );

    void layerRemoved( const QString &layerId );

    void allLayersRemoved();

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

    void layerWasAdded( QgsMapLayer *layer );

  private slots:

    void onMapLayerDeleted( QObject *obj );

  private:

    QMap<QString, QgsMapLayer *> mMapLayers;

};

#endif //QGSMAPLAYERSTORE_H