qgsdatabasetablemodel.h

Go to the documentation of this file.

/***************************************************************************
   qgsdatabasetablemodel.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 QGSDATABASETABLEMODEL_H
#define QGSDATABASETABLEMODEL_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractdatabaseproviderconnection.h"
 
#include <QAbstractItemModel>
#include <QSortFilterProxyModel>

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

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsDatabaseTableModel, Role ) : int
    {
      TableName SIP_MONKEYPATCH_COMPAT_NAME(RoleTableName) = Qt::UserRole, 
      Schema SIP_MONKEYPATCH_COMPAT_NAME(RoleSchema), 
      TableFlags SIP_MONKEYPATCH_COMPAT_NAME(RoleTableFlags), 
      Comment SIP_MONKEYPATCH_COMPAT_NAME(RoleComment), 
      CustomInfo SIP_MONKEYPATCH_COMPAT_NAME(RoleCustomInfo), 
      WkbType SIP_MONKEYPATCH_COMPAT_NAME(RoleWkbType), 
      Crs SIP_MONKEYPATCH_COMPAT_NAME(RoleCrs), 
      Empty SIP_MONKEYPATCH_COMPAT_NAME(RoleEmpty), 
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    explicit QgsDatabaseTableModel( const QString &provider, const QString &connection, const QString &schema = QString(), QObject *parent SIP_TRANSFERTHIS = nullptr );

    explicit QgsDatabaseTableModel( QgsAbstractDatabaseProviderConnection *connection SIP_TRANSFER, const QString &schema = QString(), QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    // 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;

    void setAllowEmptyTable( bool allowEmpty );

    bool allowEmptyTable() const { return mAllowEmpty; }
 
  public slots:

    void refresh();
 
  private:
    void init();
    std::unique_ptr< QgsAbstractDatabaseProviderConnection > mConnection;
    QString mSchema;
    QList<QgsAbstractDatabaseProviderConnection::TableProperty> mTables;
    bool mAllowEmpty = false;
};
 
#endif // QGSDATABASETABLEMODEL_H