qgscoordinatereferencesystemmodel.h

Go to the documentation of this file.

/***************************************************************************
                             qgscoordinatereferencesystemmodel.h
                             -------------------
    begin                : July 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 QGSCOORDINATEREFERENCESYSTEMMODEL_H
#define QGSCOORDINATEREFERENCESYSTEMMODEL_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscoordinatereferencesystemregistry.h"
 
#include <QAbstractItemModel>
#include <QIcon>
#include <QSortFilterProxyModel>
 
class QgsCoordinateReferenceSystem;
class QgsCoordinateReferenceSystemModelGroupNode;

#ifndef SIP_RUN

class GUI_EXPORT QgsCoordinateReferenceSystemModelNode
{
  public:
    enum NodeType
    {
      NodeGroup, 
      NodeCrs,   
    };
 
    virtual ~QgsCoordinateReferenceSystemModelNode();

    virtual NodeType nodeType() const = 0;

    QgsCoordinateReferenceSystemModelNode *parent() { return mParent; }

    QList<QgsCoordinateReferenceSystemModelNode *> children() { return mChildren; }

    QList<QgsCoordinateReferenceSystemModelNode *> children() const { return mChildren; }

    QgsCoordinateReferenceSystemModelNode *takeChild( QgsCoordinateReferenceSystemModelNode *node );

    QgsCoordinateReferenceSystemModelNode *addChildNode( std::unique_ptr< QgsCoordinateReferenceSystemModelNode > node );

    void deleteChildren();

    QgsCoordinateReferenceSystemModelGroupNode *getChildGroupNode( const QString &id );
 
  private:
    QgsCoordinateReferenceSystemModelNode *mParent = nullptr;
    QList<QgsCoordinateReferenceSystemModelNode *> mChildren;
};

class GUI_EXPORT QgsCoordinateReferenceSystemModelGroupNode : public QgsCoordinateReferenceSystemModelNode
{
  public:
    QgsCoordinateReferenceSystemModelGroupNode( const QString &name, const QIcon &icon, const QString &id );

    QString id() const { return mId; }

    QString name() const { return mName; }

    QIcon icon() const { return mIcon; }
 
    NodeType nodeType() const override { return NodeGroup; }
 
  private:
    QString mId;
    QString mName;
    QIcon mIcon;
};

class GUI_EXPORT QgsCoordinateReferenceSystemModelCrsNode : public QgsCoordinateReferenceSystemModelNode
{
  public:
    QgsCoordinateReferenceSystemModelCrsNode( const QgsCrsDbRecord &record );
 
    NodeType nodeType() const override { return NodeCrs; }

    const QgsCrsDbRecord &record() const { return mRecord; }

    void setWkt( const QString &wkt ) { mWkt = wkt; }

    QString wkt() const { return mWkt; }

    void setProj( const QString &proj ) { mProj = proj; }

    QString proj() const { return mProj; }

    void setGroup( const QString &group ) { mGroup = group; }

    QString group() const { return mGroup; }

    void setProjection( const QString &projection ) { mProjection = projection; }

    QString projection() const { return mProjection; }
 
  private:
    const QgsCrsDbRecord mRecord;
    QString mWkt;
    QString mProj;
    QString mGroup;
    QString mProjection;
};
 
#endif

class GUI_EXPORT QgsCoordinateReferenceSystemModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsCoordinateReferenceSystemModel, Roles ) : int
    {
      NodeType SIP_MONKEYPATCH_COMPAT_NAME( RoleNodeType ) = Qt::UserRole,         
      Name SIP_MONKEYPATCH_COMPAT_NAME( RoleName ) = Qt::UserRole + 1,             
      AuthId SIP_MONKEYPATCH_COMPAT_NAME( RoleAuthId ) = Qt::UserRole + 2,         
      Deprecated SIP_MONKEYPATCH_COMPAT_NAME( RoleDeprecated ) = Qt::UserRole + 3, 
      Type SIP_MONKEYPATCH_COMPAT_NAME( RoleType ) = Qt::UserRole + 4,             
      GroupId SIP_MONKEYPATCH_COMPAT_NAME( RoleGroupId ) = Qt::UserRole + 5,       
      Wkt SIP_MONKEYPATCH_COMPAT_NAME( RoleWkt ) = Qt::UserRole + 6,               
      Proj SIP_MONKEYPATCH_COMPAT_NAME( RoleProj ) = Qt::UserRole + 7,             
      Group = Qt::UserRole + 8,                                                    
      Projection = Qt::UserRole + 9,                                               
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    QgsCoordinateReferenceSystemModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    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 ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex & = QModelIndex() ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;

    QModelIndex addCustomCrs( const QgsCoordinateReferenceSystem &crs );

    QModelIndex authIdToIndex( const QString &authId ) const;
 
  private slots:
 
    void rebuild();
    void userCrsAdded( const QString &id );
    void userCrsRemoved( long id );
    void userCrsChanged( const QString &id );
 
  private:
    QgsCoordinateReferenceSystemModelCrsNode *addRecord( const QgsCrsDbRecord &record );
 
    QgsCoordinateReferenceSystemModelNode *index2node( const QModelIndex &index ) const;
    QModelIndex node2index( QgsCoordinateReferenceSystemModelNode *node ) const;
    QModelIndex indexOfParentTreeNode( QgsCoordinateReferenceSystemModelNode *parentNode ) const;
 
 
    std::unique_ptr<QgsCoordinateReferenceSystemModelGroupNode> mRootNode;
 
    QList<QgsCrsDbRecord> mCrsDbRecords;
};
 

class GUI_EXPORT QgsCoordinateReferenceSystemProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    enum Filter SIP_ENUM_BASETYPE( IntFlag )
    {
      FilterHorizontal = 1 << 1, 
      FilterVertical = 1 << 2,   
      FilterCompound = 1 << 3,   
    };
    Q_DECLARE_FLAGS( Filters, Filter )
    Q_FLAG( Filters )
 
    
    explicit QgsCoordinateReferenceSystemProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );

    QgsCoordinateReferenceSystemModel *coordinateReferenceSystemModel();

    const QgsCoordinateReferenceSystemModel *coordinateReferenceSystemModel() const SIP_SKIP;

    void setFilters( QgsCoordinateReferenceSystemProxyModel::Filters filters );

    Filters filters() const { return mFilters; }

    void setFilterString( const QString &filter );

    QString filterString() const { return mFilterString; }

    void setFilterAuthIds( const QSet<QString> &filter );

    QSet<QString> filterAuthIds() const { return mFilterAuthIds; }

    void setFilterDeprecated( bool filter );

    bool filterDeprecated() const { return mFilterDeprecated; }
 
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
 
  private:
    QgsCoordinateReferenceSystemModel *mModel = nullptr;
    QString mFilterString;
    QSet<QString> mFilterAuthIds;
    bool mFilterDeprecated = false;
    Filters mFilters = Filters();
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsCoordinateReferenceSystemProxyModel::Filters )
 
 
#endif // QGSCOORDINATEREFERENCESYSTEMMODEL_H