qgsbrowserproxymodel.h

Go to the documentation of this file.

/***************************************************************************
    qgsbrowserproxymodel.h
    ---------------------
    begin                : October 2018
    copyright            : (C) 2018 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 QGSBROWSERPROXYMODEL_H
#define QGSBROWSERPROXYMODEL_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QSortFilterProxyModel>
 
class QgsBrowserModel;
class QgsDataItem;

class CORE_EXPORT QgsBrowserProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
  public:
    enum FilterSyntax
    {
      Normal,            
      Wildcards,         
      RegularExpression, 
    };

    explicit QgsBrowserProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setBrowserModel( QgsBrowserModel *model );

    QgsBrowserModel *browserModel() { return mModel; }

    QgsDataItem *dataItem( const QModelIndex &index ) const;

    void setFilterSyntax( FilterSyntax syntax );

    FilterSyntax filterSyntax() const;

    void setFilterString( const QString &filter );

    QString filterString() const;

    void setFilterCaseSensitivity( Qt::CaseSensitivity sensitivity );

    Qt::CaseSensitivity caseSensitivity() const;

    bool filterByLayerType() const { return mFilterByLayerType; }

    void setFilterByLayerType( bool enabled );

    Qgis::LayerType layerType() const;

    void setLayerType( Qgis::LayerType type );

    void setHiddenDataItemProviderKeyFilter( const QStringList &hiddenItemsFilter );

    void setShownDataItemProviderKeyFilter( const QStringList &shownItemsFilter );

    bool showLayers() const;

    void setShowLayers( bool showLayers );
 
  protected:
    // It would be better to apply the filer only to expanded (visible) items, but using mapFromSource() + view here was causing strange errors
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;

    QgsBrowserModel *mModel = nullptr;
 
  private:
    QStringList mHiddenDataItemsKeys;
    QStringList mShownDataItemsKeys;
    QString mFilter;                     //filter string provided
    QVector<QRegularExpression> mREList; //list of filters, separated by "|"
    FilterSyntax mPatternSyntax = Normal;
    Qt::CaseSensitivity mCaseSensitivity = Qt::CaseInsensitive;
 
    bool mFilterByLayerType = false;
    bool mShowLayers = true;
    Qgis::LayerType mLayerType = Qgis::LayerType::Vector;

    void updateFilter();

    bool filterAcceptsString( const QString &value ) const;

    bool filterAcceptsAncestor( const QModelIndex &sourceIndex ) const;

    bool filterAcceptsDescendant( const QModelIndex &sourceIndex ) const;

    bool filterAcceptsItem( const QModelIndex &sourceIndex ) const;

    bool filterAcceptsProviderKey( const QModelIndex &sourceIndex ) const;

    bool filterRootAcceptsProviderKey( const QModelIndex &sourceIndex ) const;
 
 
    // QAbstractItemModel interface
  public:
    bool hasChildren( const QModelIndex &parent = QModelIndex() ) const override;
};
 
#endif // QGSBROWSERPROXYMODEL_H