qgsprovidersublayermodel.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprovidersublayermodel.h
                             ----------------------
    begin                : June 2021
    copyright            : (C) 2021 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 QGSPROVIDERSUBLAYERMODEL_H
#define QGSPROVIDERSUBLAYERMODEL_H
 
#include <deque>
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsprovidersublayerdetails.h"
 
#include <QAbstractItemModel>
#include <QIcon>
#include <QSortFilterProxyModel>
#include <QString>
 
using namespace Qt::StringLiterals;

class QgsProviderSublayerModelNode;
class QgsProviderSublayerModelGroup;
class QgsProviderSublayerModelSublayerNode;
 

class CORE_EXPORT QgsProviderSublayerModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    enum class Role : int
    {
      ProviderKey = Qt::UserRole + 1, 
      LayerType,                      
      Uri,                            
      Name,                           
      Description,                    
      Path,                           
      FeatureCount,                   
      WkbType,                        
      GeometryColumnName,             
      LayerNumber,                    
      IsNonLayerItem,                 
      NonLayerItemType,               
      Flags,                          
    };

    enum class Column : int
    {
      Name = 0,        
      Description = 1, 
    };

    class CORE_EXPORT NonLayerItem
    {
      public:
        QString type() const;

        void setType( const QString &type );

        QString name() const;

        void setName( const QString &name );

        QString description() const;

        void setDescription( const QString &description );

        QString uri() const;

        void setUri( const QString &uri );

        QIcon icon() const;

        void setIcon( const QIcon &icon );
 
        bool operator==( const QgsProviderSublayerModel::NonLayerItem &other ) const;
        bool operator!=( const QgsProviderSublayerModel::NonLayerItem &other ) const;
 
#ifdef SIP_RUN
        // clang-format off
        SIP_PYOBJECT __repr__();
        % MethodCode
        QString str = u"<QgsProviderSublayerModel.NonLayerItem: %1 - %2>"_s.arg( sipCpp->type(), sipCpp->name() );
        sipRes = PyUnicode_FromString( str.toUtf8().constData() );
        % End
// clang-format on
#endif
 
        // clang-format off
        private:
        // clang-format on
 
        QString mType;
        QString mName;
        QString mDescription;
        QString mUri;
        QIcon mIcon;
    };

    QgsProviderSublayerModel( QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setSublayerDetails( const QList< QgsProviderSublayerDetails > &details );

    QList< QgsProviderSublayerDetails > sublayerDetails() const;

    QgsProviderSublayerDetails indexToSublayer( const QModelIndex &index ) const;

    QgsProviderSublayerModel::NonLayerItem indexToNonLayerItem( const QModelIndex &index ) const;

    void addNonLayerItem( const QgsProviderSublayerModel::NonLayerItem &item );
 
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    int rowCount( const QModelIndex &parent ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;


    QgsProviderSublayerModelNode *index2node( const QModelIndex &index ) const SIP_SKIP;
 
  protected:
    QList<QgsProviderSublayerDetails> mSublayers;
 
    std::unique_ptr< QgsProviderSublayerModelGroup > mRootNode;
 
  private:
    QModelIndex indexOfParentNode( QgsProviderSublayerModelNode *parentNode ) const;
 
    QModelIndex node2index( QgsProviderSublayerModelNode *node ) const;
};
 
 
#ifndef SIP_RUN
 
class CORE_EXPORT QgsProviderSublayerModelNode
{
  public:
    virtual ~QgsProviderSublayerModelNode();

    QgsProviderSublayerModelGroup *parent() { return mParent; }

    virtual QVariant data( int role = Qt::DisplayRole, int column = 0 ) const = 0;

    virtual int childCount() const = 0;
 
  protected:
    QgsProviderSublayerModelGroup *mParent = nullptr;
 
    friend class QgsProviderSublayerModelGroup;
};
 
class CORE_EXPORT QgsProviderSublayerModelGroup : public QgsProviderSublayerModelNode
{
  public:
    QgsProviderSublayerModelGroup( const QString &title );
 
    QgsProviderSublayerModelGroup( QgsProviderSublayerModelGroup &&other ) = default;
    QgsProviderSublayerModelGroup &operator=( QgsProviderSublayerModelGroup && ) = default;

    QString name() const { return mGroupTitle; }

    QgsProviderSublayerModelNode *addChild( std::unique_ptr< QgsProviderSublayerModelNode > child );

    int indexOf( QgsProviderSublayerModelNode *child ) const;

    QgsProviderSublayerModelNode *childAt( int index );

    void removeChildAt( int index );

    QgsProviderSublayerModelGroup *findGroup( const QString &name ) const;

    QgsProviderSublayerModelGroup *findGroupForPath( const QStringList &path ) const;
 
    QgsProviderSublayerModelSublayerNode *findSublayer( const QgsProviderSublayerDetails &sublayer );
 
    int childCount() const final { return mChildren.size(); }
    QVariant data( int role = Qt::DisplayRole, int column = 0 ) const override;
 
    void populateFromSublayers( const QList<QgsProviderSublayerDetails> &sublayers );
 
  protected:
    std::deque< std::unique_ptr< QgsProviderSublayerModelNode > > mChildren;
 
    QString mGroupTitle;
};
 
class CORE_EXPORT QgsProviderSublayerModelSublayerNode : public QgsProviderSublayerModelNode
{
  public:
    QgsProviderSublayerModelSublayerNode( const QgsProviderSublayerDetails &sublayer );
    int childCount() const final { return 0; }
    QVariant data( int role = Qt::DisplayRole, int column = 0 ) const override;
    QgsProviderSublayerDetails sublayer() const { return mSublayer; }
 
  private:
    QgsProviderSublayerDetails mSublayer;
};
 
class CORE_EXPORT QgsProviderSublayerModelNonLayerItemNode : public QgsProviderSublayerModelNode
{
  public:
    QgsProviderSublayerModelNonLayerItemNode( const QgsProviderSublayerModel::NonLayerItem &item );
    int childCount() const final { return 0; }
    QVariant data( int role = Qt::DisplayRole, int column = 0 ) const override;
 
    QgsProviderSublayerModel::NonLayerItem item() const { return mItem; }
 
  private:
    QgsProviderSublayerModel::NonLayerItem mItem;
};

#endif

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

    QString filterString() const;

    void setFilterString( const QString &filter );

    bool includeSystemTables() const;

    void setIncludeSystemTables( bool include );

    bool includeEmptyLayers() const;

    void setIncludeEmptyLayers( bool include );
 
  protected:
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
    bool lessThan( const QModelIndex &source_left, const QModelIndex &source_right ) const override;
 
  private:
    QString mFilterString;
    bool mIncludeSystemTables = false;
    bool mIncludeEmptyLayers = true;
};
 
 
#endif // QGSPROVIDERSUBLAYERMODEL_H