kworship/KwDatabaseSetup.h

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _KwDatabaseSetup_h_
  21 #define _KwDatabaseSetup_h_
  22
  23 /**
  24  * @file KwDatabaseSetup.h
  25  * @brief Database setup manager.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QUrl>
  30 #include <QSqlDatabase>
  31
  32 /// Database setup manager.
  33 class KwDatabaseSetup
  34 {
  35   public:
  36
  37     /*
  38      * Constructors + destructor
  39      */
  40
  41     /// Default constructor.
  42     KwDatabaseSetup(bool testing = false);
  43
  44     /// Destructor.
  45     virtual ~KwDatabaseSetup();
  46
  47     /*
  48      * Initialisation
  49      */
  50
  51     /** Initialise from configuration.
  52      * @return Whether the initialisation succeeded.
  53      */
  54     bool initialiseFromConfig();
  55
  56     /** Initialise connection to a remote database.
  57      * @param type "QMYSQL" or "QPSQL".
  58      * @param host Hostname of database server.
  59      * @param dbname Database name.
  60      * @param username Username to connect with.
  61      * @param password Password (set null if none).
  62      * @return Whether the initialisation succeeded.
  63      */
  64     bool initialiseConnection(QString type, QString host, QString dbname, QString username, QString password = QString());
  65
  66     /** Initialise local file-based database.
  67      * @param type "QSQLITE".
  68      * @param url Url of database file.
  69      * @return Whether the initialisation succeeded.
  70      */
  71     bool initialiseFile(QString type, QUrl url);
  72
  73     /*
  74      * Accessors
  75      */
  76
  77     /// Get the database object.
  78     QSqlDatabase& database();
  79
  80   private:
  81
  82     /*
  83      * Variables
  84      */
  85
  86     /** Testing mode.
  87      * This is for the test button in database configuration window.
  88      */
  89     bool m_testing;
  90
  91     /// Database object.
  92     QSqlDatabase m_database;
  93 };
  94
  95 #endif // _KwDatabaseSetup_h_
  96