1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtSql module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #include "qsqldriverplugin.h"

    43 

    44 QT_BEGIN_NAMESPACE

    45 

    46 /*!

    47     \class QSqlDriverPlugin

    48     \brief The QSqlDriverPlugin class provides an abstract base for custom QSqlDriver plugins.

    49 

    50     \ingroup plugins

    51     \inmodule QtSql

    52 

    53     The SQL driver plugin is a simple plugin interface that makes it

    54     easy to create your own SQL driver plugins that can be loaded

    55     dynamically by Qt.

    56 

    57     Writing a SQL plugin is achieved by subclassing this base class,

    58     reimplementing the pure virtual functions keys() and create(), and

    59     exporting the class with the Q_EXPORT_PLUGIN2() macro. See the SQL

    60     plugins that come with Qt for example implementations (in the

    61     \c{plugins/src/sqldrivers} subdirectory of the source

    62     distribution).

    63 

    64     \sa {How to Create Qt Plugins}

    65 */

    66 

    67 /*!

    68     \fn QStringList QSqlDriverPlugin::keys() const

    69 

    70     Returns the list of drivers (keys) this plugin supports.

    71 

    72     These keys are usually the class names of the custom drivers that

    73     are implemented in the plugin.

    74 

    75     \sa create()

    76 */

    77 

    78 /*!

    79     \fn QSqlDriver *QSqlDriverPlugin::create(const QString& key)

    80 

    81     Creates and returns a QSqlDriver object for the driver called \a

    82     key. The driver key is usually the class name of the required

    83     driver. Keys are case sensitive.

    84 

    85     \sa keys()

    86 */

    87 

    88 /*!

    89     Constructs a SQL driver plugin and sets the parent to \a parent.

    90     This is invoked automatically by the Q_EXPORT_PLUGIN2() macro.

    91 */

    92 

    93 QSqlDriverPlugin::QSqlDriverPlugin(QObject *parent)

    94     : QObject(parent)

    95 {

    96 }

    97 

    98 /*!

    99     Destroys the SQL driver plugin.

   100 

   101     You never have to call this explicitly. Qt destroys a plugin

   102     automatically when it is no longer used.

   103 */

   104 QSqlDriverPlugin::~QSqlDriverPlugin()

   105 {

   106 }

   107 

   108 QT_END_NAMESPACE