- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qimagereader.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtGui module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QIMAGEREADER_H
    00043 #define QIMAGEREADER_H
    00044
    00045 #include <QtCore/qbytearray.h>
    00046 #include <QtGui/qimage.h>
    00047 #include <QtGui/qimageiohandler.h>
    00048
    00049 QT_BEGIN_HEADER
    00050
    00051 QT_BEGIN_NAMESPACE
    00052
    00053 QT_MODULE(Gui)
    00054
    00055 class QColor;
    00056 class QIODevice;
    00057 class QRect;
    00058 class QSize;
    00059 class QStringList;
    00060
    00061 class QImageReaderPrivate;
    00062 class Q_GUI_EXPORT QImageReader
    00063 {
    00064 public:
    00065     enum ImageReaderError {
    00066         UnknownError,
    00067         FileNotFoundError,
    00068         DeviceError,
    00069         UnsupportedFormatError,
    00070         InvalidDataError
    00071     };
    00072
    00073     QImageReader();
    00074     explicit QImageReader(QIODevice *device, const QByteArray &format = QByteArray());
    00075     explicit QImageReader(const QString &fileName, const QByteArray &format = QByteArray());
    00076     ~QImageReader();
    00077
    00078     void setFormat(const QByteArray &format);
    00079     QByteArray format() const;
    00080
    00081     void setAutoDetectImageFormat(bool enabled);
    00082     bool autoDetectImageFormat() const;
    00083
    00084     void setDecideFormatFromContent(bool ignored);
    00085     bool decideFormatFromContent() const;
    00086
    00087     void setDevice(QIODevice *device);
    00088     QIODevice *device() const;
    00089
    00090     void setFileName(const QString &fileName);
    00091     QString fileName() const;
    00092
    00093     QSize size() const;
    00094
    00095     QImage::Format imageFormat() const;
    00096
    00097     QStringList textKeys() const;
    00098     QString text(const QString &key) const;
    00099
    00100     void setClipRect(const QRect &rect);
    00101     QRect clipRect() const;
    00102
    00103     void setScaledSize(const QSize &size);
    00104     QSize scaledSize() const;
    00105
    00106     void setQuality(int quality);
    00107     int quality() const;
    00108
    00109     void setScaledClipRect(const QRect &rect);
    00110     QRect scaledClipRect() const;
    00111
    00112     void setBackgroundColor(const QColor &color);
    00113     QColor backgroundColor() const;
    00114
    00115     bool supportsAnimation() const;
    00116
    00117     bool canRead() const;
    00118     QImage read();
    00119     bool read(QImage *image);
    00120
    00121     bool jumpToNextImage();
    00122     bool jumpToImage(int imageNumber);
    00123     int loopCount() const;
    00124     int imageCount() const;
    00125     int nextImageDelay() const;
    00126     int currentImageNumber() const;
    00127     QRect currentImageRect() const;
    00128
    00129     ImageReaderError error() const;
    00130     QString errorString() const;
    00131
    00132     bool supportsOption(QImageIOHandler::ImageOption option) const;
    00133
    00134     static QByteArray imageFormat(const QString &fileName);
    00135     static QByteArray imageFormat(QIODevice *device);
    00136     static QList<QByteArray> supportedImageFormats();
    00137
    00138 private:
    00139     Q_DISABLE_COPY(QImageReader)
    00140     QImageReaderPrivate *d;
    00141 };
    00142
    00143 QT_END_NAMESPACE
    00144
    00145 QT_END_HEADER
    00146
    00147 #endif // QIMAGEREADER_H