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 "qiconengineplugin.h"
41#include "qiconengine.h"
42
43QT_BEGIN_NAMESPACE
44
45/*!
46 \class QIconEnginePlugin
47 \brief The QIconEnginePlugin class provides an abstract base for custom QIconEngine plugins.
48
49 \ingroup plugins
50 \inmodule QtGui
51
52 The icon engine plugin is a simple plugin interface that makes it easy to
53 create custom icon engines that can be loaded dynamically into applications
54 through QIcon. QIcon uses the file or resource name's suffix to determine
55 what icon engine to use.
56
57 Writing a icon engine plugin is achieved by subclassing this base class,
58 reimplementing the pure virtual function create(), and
59 exporting the class with the Q_PLUGIN_METADATA() macro.
60
61 The json metadata should contain a list of icon engine keys that this plugin supports.
62 The keys correspond to the suffix of the file or resource name used when the plugin was
63 created. Keys are case insensitive.
64
65 \code
66 { "Keys": [ "myiconengine" ] }
67 \endcode
68
69 \sa {How to Create Qt Plugins}
70*/
71
72/*!
73 \fn QIconEngine* QIconEnginePlugin::create(const QString& filename)
74
75 Creates and returns a QIconEngine object for the icon with the given
76 \a filename.
77*/
78
79/*!
80 Constructs a icon engine plugin with the given \a parent. This is invoked
81 automatically by the plugin loader.
82*/
83QIconEnginePlugin::QIconEnginePlugin(QObject *parent)
84 : QObject(parent)
85{
86}
87
88/*!
89 Destroys the icon engine plugin.
90
91 You never have to call this explicitly. Qt destroys a plugin
92 automatically when it is no longer used.
93*/
94QIconEnginePlugin::~QIconEnginePlugin()
95{
96}
97
98
99QT_END_NAMESPACE
100