| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the QtSql module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qsqldriverplugin.h" |
| |
| QT_BEGIN_NAMESPACE |
| |
| /*! |
| \class QSqlDriverPlugin |
| \brief The QSqlDriverPlugin class provides an abstract base for custom QSqlDriver plugins. |
| |
| \ingroup plugins |
| \inmodule QtSql |
| |
| The SQL driver plugin is a simple plugin interface that makes it |
| easy to create your own SQL driver plugins that can be loaded |
| dynamically by Qt. |
| |
| Writing a SQL plugin is achieved by subclassing this base class, |
| reimplementing the pure virtual function create(), and |
| exporting the class with the Q_PLUGIN_METADATA() macro. See the SQL |
| plugins that come with Qt for example implementations (in the |
| \c{plugins/src/sqldrivers} subdirectory of the source |
| distribution). |
| |
| The json file containing the metadata for the plugin contains a list of |
| keys indicating the supported sql drivers |
| |
| \code |
| { "Keys": [ "mysqldriver" ] } |
| \endcode |
| |
| \sa {How to Create Qt Plugins} |
| */ |
| |
| /*! |
| \fn QSqlDriver *QSqlDriverPlugin::create(const QString& key) |
| |
| Creates and returns a QSqlDriver object for the driver called \a |
| key. The driver key is usually the class name of the required |
| driver. Keys are case sensitive. |
| |
| \sa {How to Create Qt Plugins} |
| */ |
| |
| /*! |
| Constructs a SQL driver plugin and sets the parent to \a parent. |
| This is invoked automatically by the moc generated code that exports the plugin. |
| */ |
| |
| QSqlDriverPlugin::QSqlDriverPlugin(QObject *parent) |
| : QObject(parent) |
| { |
| } |
| |
| /*! |
| Destroys the SQL driver plugin. |
| |
| You never have to call this explicitly. Qt destroys a plugin |
| automatically when it is no longer used. |
| */ |
| QSqlDriverPlugin::~QSqlDriverPlugin() |
| { |
| } |
| |
| QT_END_NAMESPACE |