src/gui/image/qimagereader.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtGui module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef QIMAGEREADER_H
       
    43 #define QIMAGEREADER_H
       
    44 
       
    45 #include <QtCore/qbytearray.h>
       
    46 #include <QtGui/qimage.h>
       
    47 #include <QtGui/qimageiohandler.h>
       
    48 
       
    49 QT_BEGIN_HEADER
       
    50 
       
    51 QT_BEGIN_NAMESPACE
       
    52 
       
    53 QT_MODULE(Gui)
       
    54 
       
    55 class QColor;
       
    56 class QIODevice;
       
    57 class QRect;
       
    58 class QSize;
       
    59 class QStringList;
       
    60 
       
    61 class QImageReaderPrivate;
       
    62 class Q_GUI_EXPORT QImageReader
       
    63 {
       
    64 public:
       
    65     enum ImageReaderError {
       
    66         UnknownError,
       
    67         FileNotFoundError,
       
    68         DeviceError,
       
    69         UnsupportedFormatError,
       
    70         InvalidDataError
       
    71     };
       
    72 
       
    73     QImageReader();
       
    74     explicit QImageReader(QIODevice *device, const QByteArray &format = QByteArray());
       
    75     explicit QImageReader(const QString &fileName, const QByteArray &format = QByteArray());
       
    76     ~QImageReader();
       
    77 
       
    78     void setFormat(const QByteArray &format);
       
    79     QByteArray format() const;
       
    80 
       
    81     void setAutoDetectImageFormat(bool enabled);
       
    82     bool autoDetectImageFormat() const;
       
    83 
       
    84     void setDecideFormatFromContent(bool ignored);
       
    85     bool decideFormatFromContent() const;
       
    86 
       
    87     void setDevice(QIODevice *device);
       
    88     QIODevice *device() const;
       
    89 
       
    90     void setFileName(const QString &fileName);
       
    91     QString fileName() const;
       
    92 
       
    93     QSize size() const;
       
    94 
       
    95     QImage::Format imageFormat() const;
       
    96 
       
    97     QStringList textKeys() const;
       
    98     QString text(const QString &key) const;
       
    99 
       
   100     void setClipRect(const QRect &rect);
       
   101     QRect clipRect() const;
       
   102 
       
   103     void setScaledSize(const QSize &size);
       
   104     QSize scaledSize() const;
       
   105 
       
   106     void setQuality(int quality);
       
   107     int quality() const;
       
   108 
       
   109     void setScaledClipRect(const QRect &rect);
       
   110     QRect scaledClipRect() const;
       
   111 
       
   112     void setBackgroundColor(const QColor &color);
       
   113     QColor backgroundColor() const;
       
   114 
       
   115     bool supportsAnimation() const;
       
   116 
       
   117     bool canRead() const;
       
   118     QImage read();
       
   119     bool read(QImage *image);
       
   120 
       
   121     bool jumpToNextImage();
       
   122     bool jumpToImage(int imageNumber);
       
   123     int loopCount() const;
       
   124     int imageCount() const;
       
   125     int nextImageDelay() const;
       
   126     int currentImageNumber() const;
       
   127     QRect currentImageRect() const;
       
   128 
       
   129     ImageReaderError error() const;
       
   130     QString errorString() const;
       
   131 
       
   132     bool supportsOption(QImageIOHandler::ImageOption option) const;
       
   133 
       
   134     static QByteArray imageFormat(const QString &fileName);
       
   135     static QByteArray imageFormat(QIODevice *device);
       
   136     static QList<QByteArray> supportedImageFormats();
       
   137 
       
   138 private:
       
   139     Q_DISABLE_COPY(QImageReader)
       
   140     QImageReaderPrivate *d;
       
   141 };
       
   142 
       
   143 QT_END_NAMESPACE
       
   144 
       
   145 QT_END_HEADER
       
   146 
       
   147 #endif // QIMAGEREADER_H