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 QtWidgets 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 "qstyleplugin.h"
41#include "qstyle.h"
42
43QT_BEGIN_NAMESPACE
44
45/*!
46 \class QStylePlugin
47 \brief The QStylePlugin class provides an abstract base for custom QStyle plugins.
48
49 \ingroup plugins
50 \inmodule QtWidgets
51
52 QStylePlugin is a simple plugin interface that makes it easy
53 to create custom styles that can be loaded dynamically into
54 applications using the QStyleFactory class.
55
56 Writing a style plugin is achieved by subclassing this base class,
57 reimplementing the pure virtual create() function, and
58 exporting the class using the Q_PLUGIN_METADATA() macro.
59
60 \snippet qstyleplugin/main.cpp 0
61
62 The json metadata file \c mystyleplugin.json for the plugin needs
63 to contain information about the names of the styles the plugins
64 supports as follows:
65
66 \quotefile qstyleplugin/mystyleplugin.json
67
68 See \l {How to Create Qt Plugins} for details.
69
70 \sa QStyleFactory, QStyle
71*/
72
73/*!
74 \fn QStyle *QStylePlugin::create(const QString& key)
75
76 Creates and returns a QStyle object for the given style \a key.
77 If a plugin cannot create a style, it should return 0 instead.
78
79 The style key is usually the class name of the required
80 style. Note that the keys are case insensitive. For example:
81
82 \snippet qstyleplugin/main.cpp 1
83*/
84
85/*!
86 Constructs a style plugin with the given \a parent.
87
88 Note that this constructor is invoked automatically by the
89 moc generated code that exports the plugin, so there is no need for calling it
90 explicitly.
91*/
92QStylePlugin::QStylePlugin(QObject *parent)
93 : QObject(parent)
94{
95}
96
97/*!
98 Destroys the style plugin.
99
100 Note that Qt destroys a plugin automatically when it is no longer
101 used, so there is no need for calling the destructor explicitly.
102*/
103QStylePlugin::~QStylePlugin()
104{
105}
106
107QT_END_NAMESPACE
108
109#include "moc_qstyleplugin.cpp"
110