blob: 6ab8351a11f8840f31217cd3ae10f311c5e84fe5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: http://www.qt-project.org/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qiconengineplugin.h"
#include "qiconengine.h"
QT_BEGIN_NAMESPACE
/*!
\class QIconEnginePlugin
\brief The QIconEnginePlugin class provides an abstract base for custom QIconEngine plugins.
\ingroup plugins
\inmodule QtWidgets
\bold {Use QIconEnginePluginV2 instead.}
The icon engine plugin is a simple plugin interface that makes it easy to
create custom icon engines that can be loaded dynamically into applications
through QIcon. QIcon uses the file or resource name's suffix to determine
what icon engine to use.
Writing a icon engine plugin is achieved by subclassing this base class,
reimplementing the pure virtual functions keys() and create(), and
exporting the class with the Q_EXPORT_PLUGIN2() macro.
\sa {How to Create Qt Plugins}
*/
/*!
\fn QStringList QIconEnginePlugin::keys() const
Returns a list of icon engine keys that this plugin supports. The keys correspond
to the suffix of the file or resource name used when the plugin was created.
Keys are case insensitive.
\sa create()
*/
/*!
\fn QIconEngine* QIconEnginePlugin::create(const QString& filename)
Creates and returns a QIconEngine object for the icon with the given
\a filename.
\sa keys()
*/
/*!
Constructs a icon engine plugin with the given \a parent. This is invoked
automatically by the Q_EXPORT_PLUGIN2() macro.
*/
QIconEnginePlugin::QIconEnginePlugin(QObject *parent)
: QObject(parent)
{
}
/*!
Destroys the icon engine plugin.
You never have to call this explicitly. Qt destroys a plugin
automatically when it is no longer used.
*/
QIconEnginePlugin::~QIconEnginePlugin()
{
}
// version 2
/*!
\class QIconEnginePluginV2
\brief The QIconEnginePluginV2 class provides an abstract base for custom QIconEngineV2 plugins.
\ingroup plugins
\inmodule QtWidgets
\since 4.3
Icon engine plugins produces \l{QIconEngine}s for \l{QIcon}s; an
icon engine is used to render the icon. The keys that identifies
the engines the plugin can create are suffixes of
icon filenames; they are returned by keys(). The create() function
receives the icon filename to return an engine for; it should
return 0 if it cannot produce an engine for the file.
Writing an icon engine plugin is achieved by inheriting
QIconEnginePluginV2, reimplementing keys() and create(), and
adding the Q_EXPORT_PLUGIN2() macro.
You should ensure that you do not duplicate keys. Qt will query
the plugins for icon engines in the order in which the plugins are
found during plugin search (see the plugins \l{How to Create Qt
Plugins}{overview document}).
\sa {How to Create Qt Plugins}
*/
/*!
\fn QStringList QIconEnginePluginV2::keys() const
Returns a list of icon engine keys that this plugin supports. The keys correspond
to the suffix of the file or resource name used when the plugin was created.
Keys are case insensitive.
\sa create()
*/
/*!
\fn QIconEngineV2* QIconEnginePluginV2::create(const QString& filename = QString())
Creates and returns a QIconEngine object for the icon with the given
\a filename.
\sa keys()
*/
/*!
Constructs a icon engine plugin with the given \a parent. This is invoked
automatically by the Q_EXPORT_PLUGIN2() macro.
*/
QIconEnginePluginV2::QIconEnginePluginV2(QObject *parent)
: QObject(parent)
{
}
/*!
Destroys the icon engine plugin.
You never have to call this explicitly. Qt destroys a plugin
automatically when it is no longer used.
*/
QIconEnginePluginV2::~QIconEnginePluginV2()
{
}
QT_END_NAMESPACE
|
