qgsproviderconnectionmodel.h

Go to the documentation of this file.

/***************************************************************************
   qgsproviderconnectionmodel.h
    --------------------------------------
   Date                 : March 2020
   Copyright            : (C) 2020 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 QGSPROVIDERCONNECTIONMODEL_H
#define QGSPROVIDERCONNECTIONMODEL_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QAbstractItemModel>
#include <QSortFilterProxyModel>
#include <QStringList>
 
class QgsProviderMetadata;

class CORE_EXPORT QgsProviderConnectionModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsProviderConnectionModel, Role ) : int
    {
      ConnectionName SIP_MONKEYPATCH_COMPAT_NAME( RoleConnectionName ) = Qt::UserRole, 
      Uri SIP_MONKEYPATCH_COMPAT_NAME( RoleUri ),                                      
      Configuration SIP_MONKEYPATCH_COMPAT_NAME( RoleConfiguration ),                  
      Empty SIP_MONKEYPATCH_COMPAT_NAME( RoleEmpty ),                                  
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    explicit QgsProviderConnectionModel( const QString &provider, QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setAllowEmptyConnection( bool allowEmpty );

    bool allowEmptyConnection() const { return mAllowEmpty; }
 
    // QAbstractItemModel interface
    QModelIndex parent( const QModelIndex &child ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent ) const override;
  private slots:
    void removeConnection( const QString &connection );
    void addConnection( const QString &connection );
 
  private:
    QString mProvider;
    QgsProviderMetadata *mMetadata = nullptr;
    QStringList mConnections;
    bool mAllowEmpty = false;
};
 
#endif // QGSPROVIDERCONNECTIONMODEL_H