blob: ca80ee50a78fb896fc8d4436ef9cc3daf13e5dab [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $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 QtGui
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 function create(), and
exporting the class with the Q_PLUGIN_METADATA() macro.
The json metadata should contain 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.
\code
{ "Keys": [ "myiconengine" ] }
\endcode
\sa {How to Create Qt Plugins}
*/
/*!
\fn QIconEngine* QIconEnginePlugin::create(const QString& filename)
Creates and returns a QIconEngine object for the icon with the given
\a filename.
*/
/*!
Constructs a icon engine plugin with the given \a parent. This is invoked
automatically by the plugin loader.
*/
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()
{
}
QT_END_NAMESPACE