qgslayertreeregistrybridge.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreeregistrybridge.h
  --------------------------------------
  Date                 : May 2014
  Copyright            : (C) 2014 by Martin Dobias
  Email                : wonder dot sk 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 QGSLAYERTREEREGISTRYBRIDGE_H
#define QGSLAYERTREEREGISTRYBRIDGE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayertreegroup.h"
 
#include <QObject>
#include <QPointer>
#include <QStringList>
 
class QgsLayerTreeNode;
class QgsMapLayer;
class QgsProject;
 

class CORE_EXPORT QgsLayerTreeRegistryBridge : public QObject
{
    Q_OBJECT
  public:

    struct InsertionPoint
    {
      InsertionPoint( QgsLayerTreeGroup *group, int position )
        : group( group ), position( position ) {}
 
      QgsLayerTreeGroup *group;
      int position = 0;
    };

    explicit QgsLayerTreeRegistryBridge( QgsLayerTreeGroup *root, QgsProject *project, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    void setEnabled( bool enabled ) { mEnabled = enabled; }
    bool isEnabled() const { return mEnabled; }
 
    void setNewLayersVisible( bool enabled ) { mNewLayersVisible = enabled; }
    bool newLayersVisible() const { return mNewLayersVisible; }

    Q_DECL_DEPRECATED void setLayerInsertionPoint( QgsLayerTreeGroup *parentGroup, int index ) SIP_DEPRECATED;

    void setLayerInsertionPoint( const InsertionPoint &insertionPoint );

    InsertionPoint layerInsertionPoint() const;

    void setLayerInsertionMethod( Qgis::LayerTreeInsertionMethod method ) { mInsertionMethod = method; }

    Qgis::LayerTreeInsertionMethod layerInsertionMethod() const { return mInsertionMethod; }
 
  signals:

    void addedLayersToLayerTree( const QList<QgsMapLayer *> &layers );
 
  protected slots:
    void layersAdded( const QList<QgsMapLayer *> &layers );
    void layersWillBeRemoved( const QStringList &layerIds );
 
    void groupWillRemoveChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo );
    void groupRemovedChildren();
 
    void removeLayersFromRegistry( const QStringList &layerIds );
 
  protected:
    QgsLayerTreeGroup *mRoot = nullptr;
    QgsProject *mProject = nullptr;
    QStringList mLayerIdsForRemoval;
    bool mRegistryRemovingLayers = false;
    bool mEnabled = true;
    bool mNewLayersVisible = true;
 
    QPointer< QgsLayerTreeGroup > mInsertionPointGroup;
    int mInsertionPointPosition = 0;
 
    Qgis::LayerTreeInsertionMethod mInsertionMethod = Qgis::LayerTreeInsertionMethod::AboveInsertionPoint;
};
 
#endif // QGSLAYERTREEREGISTRYBRIDGE_H