qgsmaplayerregistry.h

Go to the documentation of this file.

/***************************************************************************
                          qgsmaplayerregistry.h
           Singleton class for keeping track of loaded layers
                             -------------------
    begin                : Sun June 04 2004
    copyright            : (C) 2004 by Tim Sutton
    email                : [email protected]
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSMAPLAYERREGISTRY_H
#define QGSMAPLAYERREGISTRY_H

#include <QMap>
#include <QSet>
#include <QObject>
#include <QStringList>
class QString;
class QgsMapLayer;

class CORE_EXPORT QgsMapLayerRegistry : public QObject
{
    Q_OBJECT

  public:
    static QgsMapLayerRegistry * instance();

    int count();

    ~QgsMapLayerRegistry();

    QgsMapLayer *mapLayer( QString theLayerId );

    QList<QgsMapLayer *> mapLayersByName( QString layerName );

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

    QList<QgsMapLayer *> addMapLayers( QList<QgsMapLayer *> theMapLayers,
                                       bool addToLegend = true,
                                       bool takeOwnership = true );

    QgsMapLayer* addMapLayer( QgsMapLayer * theMapLayer, bool addToLegend = true, bool takeOwnership = true );

    void removeMapLayers( QStringList theLayerIds );

    void removeMapLayer( const QString& theLayerId );

    void removeAllMapLayers();


    Q_DECL_DEPRECATED void clearAllLayerCaches();

    void reloadAllLayers();

  signals:
    void layersWillBeRemoved( QStringList theLayerIds );

    void layerWillBeRemoved( QString theLayerId );

    void layersRemoved( QStringList theLayerIds );

    void layerRemoved( QString theLayerId );


    void removeAll();

    void layersAdded( QList<QgsMapLayer *> theMapLayers );

    void layerWasAdded( QgsMapLayer* theMapLayer );

    void legendLayersAdded( QList<QgsMapLayer*> theMapLayers );

  protected:
    void connectNotify( const char * signal );

  private:
    QgsMapLayerRegistry( QObject * parent = 0 );

    static QgsMapLayerRegistry *mInstance;
    QMap<QString, QgsMapLayer*> mMapLayers;
    QSet<QgsMapLayer*> mOwnedLayers;
}; // class QgsMapLayerRegistry

#endif //QgsMapLayerRegistry_H