/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsmaplayerstore.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsMapLayerStore : QObject
{
%Docstring(signature="appended")
A storage object for map layers, in which the layers are owned by the
store and have their lifetime bound to the store.
%End

%TypeHeaderCode
#include "qgsmaplayerstore.h"
%End
  public:

    explicit QgsMapLayerStore( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsMapLayerStore.
%End

    ~QgsMapLayerStore();

    int count() const;
%Docstring
Returns the number of layers contained in the store.
%End

    int validCount() const;
%Docstring
Returns the number of valid layers contained in the store.

.. versionadded:: 3.6
%End


    Py_ssize_t __len__() const;
%Docstring
Returns the number of layers contained in the store.
%End
%MethodCode
    sipRes = sipCpp->count();
%End

    //! Ensures that bool(obj) returns ``True`` (otherwise __len__() would be used)
    int __bool__() const;
%MethodCode
    sipRes = true;
%End

    QgsMapLayer *mapLayer( const QString &id ) const;
%Docstring
Retrieve a pointer to a layer by layer ``id``.

:param id: ID of layer to retrieve

:return: matching layer, or ``None`` if no matching layer found

.. seealso:: :py:func:`mapLayersByName`

.. seealso:: :py:func:`mapLayers`
%End

    QList<QgsMapLayer *> mapLayersByName( const QString &name ) const;
%Docstring
Retrieve a list of matching layers by layer ``name``.

:param name: name of layers to match

:return: list of matching layers

.. seealso:: :py:func:`mapLayer`

.. seealso:: :py:func:`mapLayers`
%End

    QMap<QString, QgsMapLayer *> mapLayers() const;
%Docstring
Returns a map of all layers by layer ID.

.. seealso:: :py:func:`mapLayer`

.. seealso:: :py:func:`mapLayersByName`

.. seealso:: :py:func:`layers`
%End

    QMap<QString, QgsMapLayer *> validMapLayers() const;
%Docstring
Returns a map of all valid layers by layer ID.

.. seealso:: :py:func:`mapLayer`

.. seealso:: :py:func:`mapLayersByName`

.. seealso:: :py:func:`layers`

.. versionadded:: 3.6
%End


    QList<QgsMapLayer *> addMapLayers( const QList<QgsMapLayer *> &layers /Transfer/ );
%Docstring
Add a list of ``layers`` to the store. Ownership of the layers is
transferred to the store.

The :py:func:`~QgsMapLayerStore.layersAdded` and
:py:func:`~QgsMapLayerStore.layerWasAdded` signals will always be
emitted.

:param layers: A list of layer which should be added to the store.

.. note::

   If a layer with the same id is already in the store it is not added again,
   but if the validity of the layer has changed from ``False`` to ``True``, the
   layer data source is updated to the new one.

:return: a list of the map layers that were added successfully. If a
         layer already exists in the store, it will not be part of the
         returned list.

.. seealso:: :py:func:`addMapLayer`
%End

    QgsMapLayer *addMapLayer( QgsMapLayer *layer /Transfer/ );
%Docstring
Add a ``layer`` to the store. Ownership of the layer is transferred to
the store.

The :py:func:`~QgsMapLayerStore.layersAdded` and
:py:func:`~QgsMapLayerStore.layerWasAdded` signals will always be
emitted. If you are adding multiple layers at once, you should use
:py:func:`~QgsMapLayerStore.addMapLayers` instead.

:param layer: A layer to add to the store

:return: ``None`` if unable to add layer, otherwise pointer to newly
         added layer

.. seealso:: :py:func:`addMapLayers`

.. note::

   Use :py:func:`~QgsMapLayerStore.addMapLayers` if adding more than one layer at a time.

.. seealso:: :py:func:`addMapLayers`
%End

    void removeMapLayers( const QStringList &layerIds ) /PyName=removeMapLayersById/;
%Docstring
Remove a set of layers from the store by layer ID.

The specified layers will be removed from the store. These layers will
also be deleted.

:param layerIds: list of IDs of the layers to remove

.. seealso:: :py:func:`takeMapLayer`

.. seealso:: :py:func:`removeMapLayer`

.. seealso:: :py:func:`removeAllMapLayers`


%End

    void removeMapLayers( const QList<QgsMapLayer *> &layers );
%Docstring
Remove a set of ``layers`` from the store.

The specified layers will be removed from the store. These layers will
also be deleted.

:param layers: A list of layers to remove. ``None`` values are ignored.

.. seealso:: :py:func:`takeMapLayer`

.. seealso:: :py:func:`removeMapLayer`

.. seealso:: :py:func:`removeAllMapLayers`
%End

    void removeMapLayer( const QString &id );
%Docstring
Remove a layer from the store by layer ``id``.

The specified layer will be removed from the store. The layer will also
be deleted.

:param id: ID of the layer to remove

.. seealso:: :py:func:`takeMapLayer`

.. seealso:: :py:func:`removeMapLayers`

.. seealso:: :py:func:`removeAllMapLayers`
%End

    void removeMapLayer( QgsMapLayer *layer );
%Docstring
Remove a ``layer`` from the store.

The specified layer will be removed from the store. The layer will also
be deleted.

:param layer: The layer to remove. ``None`` values are ignored.

.. seealso:: :py:func:`takeMapLayer`

.. seealso:: :py:func:`removeMapLayers`

.. seealso:: :py:func:`removeAllMapLayers`
%End

    QgsMapLayer *takeMapLayer( QgsMapLayer *layer ) /TransferBack/;
%Docstring
Takes a ``layer`` from the store. If the layer was owned by the store,
the layer will be returned without deleting it. The caller takes
ownership of the layer and is responsible for deleting it.

.. seealso:: :py:func:`removeMapLayer`
%End

    void removeAllMapLayers();
%Docstring
Removes all registered layers. These layers will also be deleted.

.. note::

   Calling this method will cause the :py:func:`~QgsMapLayerStore.removeAll` signal to
   be emitted.

.. seealso:: :py:func:`removeMapLayer`

.. seealso:: :py:func:`removeMapLayers`
%End

    void transferLayersFromStore( QgsMapLayerStore *other );
%Docstring
Transfers all the map layers contained within another map layer store
and adds them to this store. Note that ``other`` and this store must
have the same thread affinity.
%End

  signals:

    void layersWillBeRemoved( const QStringList &layerIds );
%Docstring
Emitted when one or more layers are about to be removed from the store.

:param layerIds: A list of IDs for the layers which are to be removed.

.. seealso:: :py:func:`layerWillBeRemoved`

.. seealso:: :py:func:`layersRemoved`
%End

    void layersWillBeRemoved( const QList<QgsMapLayer *> &layers );
%Docstring
Emitted when one or more layers are about to be removed from the store.

:param layers: A list of layers which are to be removed.

.. seealso:: :py:func:`layerWillBeRemoved`

.. seealso:: :py:func:`layersRemoved`
%End

    void layerWillBeRemoved( const QString &layerId );
%Docstring
Emitted when a layer is about to be removed from the store.

:param layerId: The ID of the layer to be removed.

.. note::

   Consider using :py:func:`~QgsMapLayerStore.layersWillBeRemoved` instead.

.. seealso:: :py:func:`layersWillBeRemoved`

.. seealso:: :py:func:`layerRemoved`
%End

    void layerWillBeRemoved( QgsMapLayer *layer );
%Docstring
Emitted when a layer is about to be removed from the store.

:param layer: The layer to be removed.

.. note::

   Consider using :py:func:`~QgsMapLayerStore.layersWillBeRemoved` instead.

.. seealso:: :py:func:`layersWillBeRemoved`

.. seealso:: :py:func:`layerRemoved`
%End

    void layersRemoved( const QStringList &layerIds );
%Docstring
Emitted after one or more layers were removed from the store.

:param layerIds: A list of IDs of the layers which were removed.

.. seealso:: :py:func:`layersWillBeRemoved`
%End

    void layerRemoved( const QString &layerId );
%Docstring
Emitted after a layer was removed from the store.

:param layerId: The ID of the layer removed.

.. note::

   Consider using :py:func:`~QgsMapLayerStore.layersRemoved` instead

.. seealso:: :py:func:`layerWillBeRemoved`
%End

    void allLayersRemoved();
%Docstring
Emitted when all layers are removed, before
:py:func:`~QgsMapLayerStore.layersWillBeRemoved` and
:py:func:`~QgsMapLayerStore.layerWillBeRemoved` signals are emitted. The
:py:func:`~QgsMapLayerStore.layersWillBeRemoved` and
:py:func:`~QgsMapLayerStore.layerWillBeRemoved` signals will still be
emitted following this signal. You can use this signal to do easy (and
fast) cleanup.
%End

    void layersAdded( const QList<QgsMapLayer *> &layers );
%Docstring
Emitted when one or more layers were added to the store.

:param layers: List of layers which have been added.

.. seealso:: :py:func:`layerWasAdded`
%End

    void layerWasAdded( QgsMapLayer *layer );
%Docstring
Emitted when a ``layer`` was added to the store.

.. note::

   Consider using :py:func:`~QgsMapLayerStore.layersAdded` instead

.. seealso:: :py:func:`layersAdded`
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsmaplayerstore.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/