qgslayertreefiltersettings.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreefiltersettings.h
  --------------------------------------
  Date                 : March 2023
  Copyright            : (C) 2023 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 QGSLAYERTREEFILTERSETTINGS_H
#define QGSLAYERTREEFILTERSETTINGS_H
 
#include <memory>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsexpressioncontext.h"
#include "qgsgeometry.h"
#include "qgsmaplayer.h"
 
#include <QMap>
#include <QString>
 
class QgsMapSettings;
class QgsLayerTree;
class QgsReferencedGeometry;

class CORE_EXPORT QgsLayerTreeFilterSettings
{
  public:

    explicit QgsLayerTreeFilterSettings( const QgsMapSettings &settings );
 
    ~QgsLayerTreeFilterSettings();
 
    QgsLayerTreeFilterSettings( const QgsLayerTreeFilterSettings &other );
 
    QgsLayerTreeFilterSettings &operator=( const QgsLayerTreeFilterSettings &other );

    QgsMapSettings &mapSettings();

    QMap<QString, QString> layerFilterExpressions() const;

    void setLayerFilterExpressions( const QMap<QString, QString> &expressions );

    void setLayerFilterExpressionsFromLayerTree( QgsLayerTree *tree );

    QString layerFilterExpression( const QString &layerId ) const;

    QgsGeometry filterPolygon() const;

    void setFilterPolygon( const QgsGeometry &polygon );

    Qgis::LayerTreeFilterFlags flags() const;

    void setFlags( Qgis::LayerTreeFilterFlags flags );

    void addVisibleExtentForLayer( QgsMapLayer *layer, const QgsReferencedGeometry &polygon );

    QgsGeometry combinedVisibleExtentForLayer( const QgsMapLayer *layer );

    QList<QgsMapLayer *> layers() const;
 
  private:
 
    QMap<QString, QString> mLayerFilterExpressions;
 
    std::unique_ptr<QgsMapSettings> mMapSettings;
 
    QgsGeometry mFilterPolygon;
 
    Qgis::LayerTreeFilterFlags mFlags;
 
    QgsWeakMapLayerPointerList mLayers;
 
    // geometry must be in layer CRS
    QMap<QString, QVector< QgsGeometry > > mLayerExtents;
 
};
 
#endif // QGSLAYERTREEFILTERSETTINGS_H