Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :     qgsogrdbconnection.h  -  QgsOgrDbConnection
       3                 :            :                              -------------------
       4                 :            :     begin                : August 2017
       5                 :            :     copyright            : (C) 2017 by Alessandro Pasotti
       6                 :            :     email                : apasotti at boundlessgeo dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSGOGRDBSCONNECTION_H
      19                 :            : #define QGSGOGRDBSCONNECTION_H
      20                 :            : 
      21                 :            : #include "qgsdatasourceuri.h"
      22                 :            : 
      23                 :            : #include <QStringList>
      24                 :            : #include "qgis_sip.h"
      25                 :            : 
      26                 :            : ///@cond PRIVATE
      27                 :            : #define SIP_NO_FILE
      28                 :            : 
      29                 :            : /*!
      30                 :            :  * \brief  Generic OGR DB Connections management
      31                 :            :  */
      32                 :          0 : class CORE_EXPORT QgsOgrDbConnection : public QObject
      33                 :            : {
      34                 :            :     Q_OBJECT
      35                 :            : 
      36                 :            :   public:
      37                 :            :     //! Constructor
      38                 :            :     explicit QgsOgrDbConnection( const QString &connName, const QString &settingsKey );
      39                 :            : 
      40                 :          0 :     static const QStringList connectionList( const QString &driverName = QStringLiteral( "GPKG" ) );
      41                 :            :     static void deleteConnection( const QString &connName, const QString &settingsKey );
      42                 :            :     static QString selectedConnection( const QString &settingsKey );
      43                 :            :     static void setSelectedConnection( const QString &connName, const QString &settingsKey );
      44                 :            : 
      45                 :            :   public:
      46                 :            : 
      47                 :            :     /**
      48                 :            :      * Returns the uri
      49                 :            :      * \see QgsDataSourceUri
      50                 :            :      */
      51                 :            :     QgsDataSourceUri uri();
      52                 :            :     //! Returns the path
      53                 :          0 :     QString path( ) const { return mPath; }
      54                 :            :     //! Returns the connection name
      55                 :          0 :     QString name() const { return mConnName; }
      56                 :            :     //! Sets the \a path fo the connection
      57                 :            :     void setPath( const QString &path );
      58                 :            :     //! Store the connection data in the settings
      59                 :            :     void save();
      60                 :            :     //! Returns true if the DB supports QGIS project storage
      61                 :            :     bool allowProjectsInDatabase();
      62                 :            : 
      63                 :            :   private:
      64                 :            :     static QString fullKey( const QString &settingsKey );
      65                 :            :     static QString connectionsPath( const QString &settingsKey );
      66                 :            :     QString mConnName;
      67                 :            :     QString mPath;
      68                 :            :     QString mSettingsKey;
      69                 :            : 
      70                 :            : };
      71                 :            : 
      72                 :            : ///@endcond
      73                 :            : #endif // QGSGOGRDBSCONNECTION_H