qgsmaplayerproxymodel.h

Go to the documentation of this file.

/***************************************************************************
   qgsmaplayerproxymodel.h
    --------------------------------------
   Date                 : 01.04.2014
   Copyright            : (C) 2014 Denis Rouzaud
   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 QGSMAPLAYERPROXYMODEL_H
#define QGSMAPLAYERPROXYMODEL_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QSortFilterProxyModel>
#include <QStringList>
 
class QgsMapLayerModel;
class QgsMapLayer;
class QgsProject;

class CORE_EXPORT QgsMapLayerProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
    Q_PROPERTY( Qgis::LayerFilters filters READ filters WRITE setFilters )
    Q_PROPERTY( QList<QgsMapLayer *> exceptedLayerList READ exceptedLayerList WRITE setExceptedLayerList )
    Q_PROPERTY( QStringList exceptedLayerIds READ exceptedLayerIds WRITE setExceptedLayerIds )
 
  public:

    explicit QgsMapLayerProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );

    QgsMapLayerModel *sourceLayerModel() const { return mModel; }

    QgsMapLayerProxyModel *setFilters( Qgis::LayerFilters filters );

    Q_DECL_DEPRECATED void setFilters( int filters ) SIP_DEPRECATED { setFilters( static_cast<Qgis::LayerFilters>( filters ) ); }

    const Qgis::LayerFilters &filters() const { return mFilters; }

    void setProject( QgsProject *project );

    static bool layerMatchesFilters( const QgsMapLayer *layer, const Qgis::LayerFilters &filters );

    Q_DECL_DEPRECATED void setLayerWhitelist( const QList<QgsMapLayer *> &layers ) SIP_DEPRECATED;

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

    Q_DECL_DEPRECATED QList<QgsMapLayer *> layerWhitelist() SIP_DEPRECATED {return mLayerAllowlist;}

    QList<QgsMapLayer *> layerAllowlist() {return mLayerAllowlist;}

    void setExceptedLayerList( const QList<QgsMapLayer *> &exceptList );

    QList<QgsMapLayer *> exceptedLayerList() {return mExceptList;}

    void setExceptedLayerIds( const QStringList &ids );

    QStringList exceptedLayerIds() const;

    void setExcludedProviders( const QStringList &providers );

    QStringList excludedProviders() const { return mExcludedProviders; }

    QString filterString() const { return mFilterString; }

    bool acceptsLayer( QgsMapLayer *layer ) const;
 
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
 
  public slots:

    void setFilterString( const QString &filter );
 
  private:
    Qgis::LayerFilters mFilters;
    QList<QgsMapLayer *> mExceptList;
    QList<QgsMapLayer *> mLayerAllowlist;
    QgsMapLayerModel *mModel = nullptr;
    QStringList mExcludedProviders;
    QString mFilterString;
};
 
#endif // QGSMAPLAYERPROXYMODEL_H