/****************************************************************************

**

** Copyright (C) 2010 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$

**

****************************************************************************/

#ifndef QIMAGEIOHANDLER_H

#define QIMAGEIOHANDLER_H

#include <QtCore/qplugin.h>

#include <QtCore/qfactoryinterface.h>

#include <QtCore/qscopedpointer.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

class QImage;

class QRect;

class QSize;

class QVariant;

class QImageIOHandlerPrivate;

class Q_GUI_EXPORT QImageIOHandler

{

    Q_DECLARE_PRIVATE(QImageIOHandler)

public:

    QImageIOHandler();

    virtual ~QImageIOHandler();

    void setDevice(QIODevice *device);

    QIODevice *device() const;

    void setFormat(const QByteArray &format);

    void setFormat(const QByteArray &format) const;

    QByteArray format() const;

    virtual QByteArray name() const;

    virtual bool canRead() const = 0;

    virtual bool read(QImage *image) = 0;

    virtual bool write(const QImage &image);

    enum ImageOption {

        Size,

        ClipRect,

        Description,

        ScaledClipRect,

        ScaledSize,

        CompressionRatio,

        Gamma,

        Quality,

        Name,

        SubType,

        IncrementalReading,

        Endianness,

        Animation,

        BackgroundColor,

        ImageFormat

    };

    virtual QVariant option(ImageOption option) const;

    virtual void setOption(ImageOption option, const QVariant &value);

    virtual bool supportsOption(ImageOption option) const;

    // incremental loading

    virtual bool jumpToNextImage();

    virtual bool jumpToImage(int imageNumber);

    virtual int loopCount() const;

    virtual int imageCount() const;

    virtual int nextImageDelay() const;

    virtual int currentImageNumber() const;

    virtual QRect currentImageRect() const;

protected:

    QImageIOHandler(QImageIOHandlerPrivate &dd);

    QScopedPointer<QImageIOHandlerPrivate> d_ptr;

private:

    Q_DISABLE_COPY(QImageIOHandler)

};

struct Q_GUI_EXPORT QImageIOHandlerFactoryInterface : public QFactoryInterface

{

    virtual QImageIOHandler *create(QIODevice *device, const QByteArray &format = QByteArray()) const = 0;

};

#define QImageIOHandlerFactoryInterface_iid "com.trolltech.Qt.QImageIOHandlerFactoryInterface"

Q_DECLARE_INTERFACE(QImageIOHandlerFactoryInterface, QImageIOHandlerFactoryInterface_iid)

class Q_GUI_EXPORT QImageIOPlugin : public QObject, public QImageIOHandlerFactoryInterface

{

    Q_OBJECT

    Q_INTERFACES(QImageIOHandlerFactoryInterface:QFactoryInterface)

public:

    explicit QImageIOPlugin(QObject *parent = 0);

    virtual ~QImageIOPlugin();

    enum Capability {

        CanRead = 0x1,

        CanWrite = 0x2,

        CanReadIncremental = 0x4

    };

    Q_DECLARE_FLAGS(Capabilities, Capability)

    virtual Capabilities capabilities(QIODevice *device, const QByteArray &format) const = 0;

    virtual QStringList keys() const = 0;

    virtual QImageIOHandler *create(QIODevice *device, const QByteArray &format = QByteArray()) const = 0;

};

Q_DECLARE_OPERATORS_FOR_FLAGS(QImageIOPlugin::Capabilities)

QT_END_NAMESPACE

QT_END_HEADER

#endif // QIMAGEIOHANDLER_H