Line | Source Code | Coverage |
---|
1 | /**************************************************************************** | - |
2 | ** | - |
3 | ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). | - |
4 | ** Contact: http://www.qt-project.org/legal | - |
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 Digia. For licensing terms and | - |
14 | ** conditions see http://qt.digia.com/licensing. For further information | - |
15 | ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software | - |
20 | ** Foundation and appearing in the file LICENSE.LGPL included in the | - |
21 | ** packaging of this file. Please review the following information to | - |
22 | ** ensure the GNU Lesser General Public License version 2.1 requirements | - |
23 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. | - |
24 | ** | - |
25 | ** In addition, as a special exception, Digia gives you certain additional | - |
26 | ** rights. These rights are described in the Digia Qt LGPL Exception | - |
27 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. | - |
28 | ** | - |
29 | ** GNU General Public License Usage | - |
30 | ** Alternatively, this file may be used under the terms of the GNU | - |
31 | ** General Public License version 3.0 as published by the Free Software | - |
32 | ** Foundation and appearing in the file LICENSE.GPL included in the | - |
33 | ** packaging of this file. Please review the following information to | - |
34 | ** ensure the GNU General Public License version 3.0 requirements will be | - |
35 | ** met: http://www.gnu.org/copyleft/gpl.html. | - |
36 | ** | - |
37 | ** | - |
38 | ** $QT_END_LICENSE$ | - |
39 | ** | - |
40 | ****************************************************************************/ | - |
41 | | - |
42 | #include "qiconengineplugin.h" | - |
43 | #include "qiconengine.h" | - |
44 | | - |
45 | QT_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 | \inmodule QtGui | - |
53 | | - |
54 | The icon engine plugin is a simple plugin interface that makes it easy to | - |
55 | create custom icon engines that can be loaded dynamically into applications | - |
56 | through QIcon. QIcon uses the file or resource name's suffix to determine | - |
57 | what icon engine to use. | - |
58 | | - |
59 | Writing a icon engine plugin is achieved by subclassing this base class, | - |
60 | reimplementing the pure virtual function create(), and | - |
61 | exporting the class with the Q_PLUGIN_METADATA() macro. | - |
62 | | - |
63 | The json metadata should contain a list of icon engine keys that this plugin supports. | - |
64 | The keys correspond to the suffix of the file or resource name used when the plugin was | - |
65 | created. Keys are case insensitive. | - |
66 | | - |
67 | \code | - |
68 | { "Keys": [ "myiconengine" ] } | - |
69 | \endcode | - |
70 | | - |
71 | \sa {How to Create Qt Plugins} | - |
72 | */ | - |
73 | | - |
74 | /*! | - |
75 | \fn QIconEngine* QIconEnginePlugin::create(const QString& filename) | - |
76 | | - |
77 | Creates and returns a QIconEngine object for the icon with the given | - |
78 | \a filename. | - |
79 | */ | - |
80 | | - |
81 | /*! | - |
82 | Constructs a icon engine plugin with the given \a parent. This is invoked | - |
83 | automatically by the plugin loader. | - |
84 | */ | - |
85 | QIconEnginePlugin::QIconEnginePlugin(QObject *parent) | - |
86 | : QObject(parent) | - |
87 | { | - |
88 | } | 0 |
89 | | - |
90 | /*! | - |
91 | Destroys the icon engine plugin. | - |
92 | | - |
93 | You never have to call this explicitly. Qt destroys a plugin | - |
94 | automatically when it is no longer used. | - |
95 | */ | - |
96 | QIconEnginePlugin::~QIconEnginePlugin() | - |
97 | { | - |
98 | } | - |
99 | | - |
100 | | - |
101 | QT_END_NAMESPACE | - |
102 | | - |
| | |