src/gui/styles/qstyleplugin.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/gui/styles/qstyleplugin.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,115 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qstyleplugin.h"
+#include "qstyle.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \class QStylePlugin
+    \brief The QStylePlugin class provides an abstract base for custom QStyle plugins.
+
+    \ingroup plugins
+
+    QStylePlugin is a simple plugin interface that makes it easy
+    to create custom styles that can be loaded dynamically into
+    applications using the QStyleFactory class.
+
+    Writing a style plugin is achieved by subclassing this base class,
+    reimplementing the pure virtual keys() and create() functions, and
+    exporting the class using the Q_EXPORT_PLUGIN2() macro. See \l
+    {How to Create Qt Plugins} for details.
+
+    \sa QStyleFactory, QStyle
+*/
+
+/*!
+    \fn QStringList QStylePlugin::keys() const
+
+    Returns the list of style keys this plugin supports.
+
+    These keys are usually the class names of the custom styles that
+    are implemented in the plugin.
+
+    \sa create()
+*/
+
+/*!
+    \fn QStyle *QStylePlugin::create(const QString& key)
+
+    Creates and returns a QStyle object for the given style \a key.
+    If a plugin cannot create a style, it should return 0 instead.
+
+    The style key is usually the class name of the required
+    style. Note that the keys are case insensitive. For example:
+
+    \snippet doc/src/snippets/qstyleplugin/main.cpp 0
+    \codeline
+    \snippet doc/src/snippets/qstyleplugin/main.cpp 1
+    \snippet doc/src/snippets/qstyleplugin/main.cpp 2
+
+    \sa keys()
+*/
+
+/*!
+    Constructs a style plugin with the given \a parent.
+
+    Note that this constructor is invoked automatically by the
+    Q_EXPORT_PLUGIN2() macro, so there is no need for calling it
+    explicitly.
+*/
+QStylePlugin::QStylePlugin(QObject *parent)
+    : QObject(parent)
+{
+}
+
+/*!
+    Destroys the style plugin.
+
+    Note that Qt destroys a plugin automatically when it is no longer
+    used, so there is no need for calling the destructor explicitly.
+*/
+QStylePlugin::~QStylePlugin()
+{
+}
+
+QT_END_NAMESPACE