src/gui/image/qpictureformatplugin.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/gui/image/qpictureformatplugin.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,139 @@
+/****************************************************************************
+**
+** 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 "qpictureformatplugin.h"
+#if !defined(QT_NO_LIBRARY) && !defined(QT_NO_PICTURE)
+#include "qpicture.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \obsolete
+
+    \class QPictureFormatPlugin
+    \brief The QPictureFormatPlugin class provides an abstract base
+    for custom picture format plugins.
+
+    \ingroup plugins
+
+    The picture format plugin is a simple plugin interface that makes
+    it easy to create custom picture formats that can be used
+    transparently by applications.
+
+    Writing an picture format plugin is achieved by subclassing this
+    base class, reimplementing the pure virtual functions keys(),
+    loadPicture(), savePicture(), and installIOHandler(), and
+    exporting the class with the Q_EXPORT_PLUGIN2() macro.
+
+    \sa {How to Create Qt Plugins}
+*/
+
+/*!
+    \fn QStringList QPictureFormatPlugin::keys() const
+
+    Returns the list of picture formats this plugin supports.
+
+    \sa installIOHandler()
+*/
+
+/*!
+    \fn bool QPictureFormatPlugin::installIOHandler(const QString &format)
+
+    Installs a QPictureIO picture I/O handler for the picture format \a
+    format.
+
+    \sa keys()
+*/
+
+
+/*!
+    Constructs an picture format plugin with the given \a parent.
+    This is invoked automatically by the Q_EXPORT_PLUGIN2() macro.
+*/
+QPictureFormatPlugin::QPictureFormatPlugin(QObject *parent)
+    : QObject(parent)
+{
+}
+
+/*!
+    Destroys the picture format plugin.
+
+    You never have to call this explicitly. Qt destroys a plugin
+    automatically when it is no longer used.
+*/
+QPictureFormatPlugin::~QPictureFormatPlugin()
+{
+}
+
+
+/*!
+    Loads the picture stored in the file called \a fileName, with the
+    given \a format, into *\a picture. Returns true on success;
+    otherwise returns false.
+
+    \sa savePicture()
+*/
+bool QPictureFormatPlugin::loadPicture(const QString &format, const QString &fileName, QPicture *picture)
+{
+    Q_UNUSED(format)
+    Q_UNUSED(fileName)
+    Q_UNUSED(picture)
+    return false;
+}
+
+/*!
+    Saves the given \a picture into the file called \a fileName,
+    using the specified \a format. Returns true on success; otherwise
+    returns false.
+
+    \sa loadPicture()
+*/
+bool QPictureFormatPlugin::savePicture(const QString &format, const QString &fileName, const QPicture &picture)
+{
+    Q_UNUSED(format)
+    Q_UNUSED(fileName)
+    Q_UNUSED(picture)
+    return false;
+}
+
+#endif // QT_NO_LIBRARY || QT_NO_PICTURE
+
+QT_END_NAMESPACE