source: trunk/src/gui/image/qiconengineplugin.cpp@ 342

Last change on this file since 342 was 2, checked in by Dmitry A. Kuminov, 17 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 5.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "qiconengineplugin.h"
43#include "qiconengine.h"
44
45QT_BEGIN_NAMESPACE
46
47/*!
48 \class QIconEnginePlugin
49 \brief The QIconEnginePlugin class provides an abstract base for custom QIconEngine plugins.
50
51 \ingroup plugins
52
53 \bold {Use QIconEnginePluginV2 instead.}
54
55 The icon engine plugin is a simple plugin interface that makes it easy to
56 create custom icon engines that can be loaded dynamically into applications
57 through QIcon. QIcon uses the file or resource name's suffix to determine
58 what icon engine to use.
59
60 Writing a icon engine plugin is achieved by subclassing this base class,
61 reimplementing the pure virtual functions keys() and create(), and
62 exporting the class with the Q_EXPORT_PLUGIN2() macro.
63
64 \sa {How to Create Qt Plugins}
65*/
66
67/*!
68 \fn QStringList QIconEnginePlugin::keys() const
69
70 Returns a list of icon engine keys that this plugin supports. The keys correspond
71 to the suffix of the file or resource name used when the plugin was created.