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 QtGui 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 "qgenericplugin.h"
41
42QT_BEGIN_NAMESPACE
43
44/*!
45 \class QGenericPlugin
46 \ingroup plugins
47 \inmodule QtGui
48
49 \brief The QGenericPlugin class is an abstract base class for
50 plugins.
51
52 A mouse plugin can be created by subclassing
53 QGenericPlugin and reimplementing the pure virtual create()
54 function. By exporting the derived class using the
55 Q_PLUGIN_METADATA() macro, The default implementation of the
56 QGenericPluginFactory class will automatically detect the plugin and
57 load the driver into the server application at run-time. See \l
58 {How to Create Qt Plugins} for details.
59
60 The json metadata file should contain a list of keys supported by this
61 plugin.
62
63 \sa QGenericPluginFactory
64*/
65
66/*!
67 Constructs a plugin with the given \a parent.
68
69 Note that this constructor is invoked automatically by the
70 moc generated code that exports the plugin, so there is no need for calling it
71 explicitly.
72*/
73QGenericPlugin::QGenericPlugin(QObject *parent)
74 : QObject(parent)
75{
76}
77
78/*!
79 Destroys the plugin.
80
81 Note that Qt destroys a plugin automatically when it is no longer
82 used, so there is no need for calling the destructor explicitly.
83*/
84QGenericPlugin::~QGenericPlugin()
85{
86}
87
88/*!
89 \fn QObject* QGenericPlugin::create(const QString &key, const QString& specification)
90
91 Implement this function to create a driver matching the type
92 specified by the given \a key and \a specification parameters. Note that
93 keys are case-insensitive.
94*/
95
96QT_END_NAMESPACE
97