1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtSql module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qsqldriverplugin.h"
41
42QT_BEGIN_NAMESPACE
43
44/*!
45 \class QSqlDriverPlugin
46 \brief The QSqlDriverPlugin class provides an abstract base for custom QSqlDriver plugins.
47
48 \ingroup plugins
49 \inmodule QtSql
50
51 The SQL driver plugin is a simple plugin interface that makes it
52 easy to create your own SQL driver plugins that can be loaded
53 dynamically by Qt.
54
55 Writing a SQL plugin is achieved by subclassing this base class,
56 reimplementing the pure virtual function create(), and
57 exporting the class with the Q_PLUGIN_METADATA() macro. See the SQL
58 plugins that come with Qt for example implementations (in the
59 \c{plugins/src/sqldrivers} subdirectory of the source
60 distribution).
61
62 The json file containing the metadata for the plugin contains a list of
63 keys indicating the supported sql drivers
64
65 \code
66 { "Keys": [ "mysqldriver" ] }
67 \endcode
68
69 \sa {How to Create Qt Plugins}
70*/
71
72/*!
73 \fn QSqlDriver *QSqlDriverPlugin::create(const QString& key)
74
75 Creates and returns a QSqlDriver object for the driver called \a
76 key. The driver key is usually the class name of the required
77 driver. Keys are case sensitive.
78
79 \sa {How to Create Qt Plugins}
80*/
81
82/*!
83 Constructs a SQL driver plugin and sets the parent to \a parent.
84 This is invoked automatically by the moc generated code that exports the plugin.
85*/
86
87QSqlDriverPlugin::QSqlDriverPlugin(QObject *parent)
88 : QObject(parent)
89{
90}
91
92/*!
93 Destroys the SQL driver plugin.
94
95 You never have to call this explicitly. Qt destroys a plugin
96 automatically when it is no longer used.
97*/
98QSqlDriverPlugin::~QSqlDriverPlugin()
99{
100}
101
102QT_END_NAMESPACE
103