qgslayertreefilterproxymodel.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreefilterproxymodel.h
 
 ---------------------
 begin                : 05.06.2020
 copyright            : (C) 2020 by Denis Rouzaud
 email                : denis@opengis.ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSLAYERTREEFILTERPROXYMODEL_H
#define QGSLAYERTREEFILTERPROXYMODEL_H
 
#include "qgis_core.h"
#include "qgsmaplayer.h"
#include "qgsmaplayerproxymodel.h"
 
#include <QSortFilterProxyModel>
 
class QgsLayerTreeModel;
class QgsLayerTreeNode;

class CORE_EXPORT QgsLayerTreeFilterProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
  public:
    QgsLayerTreeFilterProxyModel( QObject *parent = nullptr );

    void setCheckedLayers( const QList<QgsMapLayer *> layers );

    QList<QgsMapLayer *> checkedLayers() const { return mCheckedLayers; }

    QgsMapLayer *mapLayer( const QModelIndex &idx ) const;

    QgsLayerTreeModel *layerTreeModel() const;
    void setLayerTreeModel( QgsLayerTreeModel *layerTreeModel );

    bool showPrivateLayers() const;

    void setShowPrivateLayers( bool showPrivate );

    void setFilters( Qgis::LayerFilters filters );
 
    int columnCount( const QModelIndex &parent ) const override;
    Qt::ItemFlags flags( const QModelIndex &idx ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &child ) const override;
    QModelIndex sibling( int row, int column, const QModelIndex &idx ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;

    bool nodeShown( QgsLayerTreeNode *node ) const;
 
  public slots:
    virtual void setFilterText( const QString &filterText = QString() );
 
  protected:
    virtual bool isLayerChecked( QgsMapLayer *layer ) const;

    virtual void setLayerChecked( QgsMapLayer *layer, bool checked );
 
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
 
  private:
    virtual bool layerShown( QgsMapLayer *layer ) const;

    void setLayerCheckedPrivate( QgsMapLayer *layer, bool checked );
 
    QgsLayerTreeModel *mLayerTreeModel = nullptr;
    QList<QgsMapLayer *> mCheckedLayers;
    QString mFilterText;
    // for compatibility this defaults to true
    bool mShowPrivateLayers = true;
    Qgis::LayerFilters mFilters = Qgis::LayerFilter::All;
};
 
#endif // QGSLAYERTREEFILTERPROXYMODEL_H