1/****************************************************************************
2**
3** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** GNU Lesser General Public License Usage
10** This file may be used under the terms of the GNU Lesser General Public
11** License version 2.1 as published by the Free Software Foundation and
12** appearing in the file LICENSE.LGPL included in the packaging of this
13** file. Please review the following information to ensure the GNU Lesser
14** General Public License version 2.1 requirements will be met:
15** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16**
17** In addition, as a special exception, Nokia gives you certain additional
18** rights. These rights are described in the Nokia Qt LGPL Exception
19** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20**
21** GNU General Public License Usage
22** Alternatively, this file may be used under the terms of the GNU General
23** Public License version 3.0 as published by the Free Software Foundation
24** and appearing in the file LICENSE.GPL included in the packaging of this
25** file. Please review the following information to ensure the GNU General
26** Public License version 3.0 requirements will be met:
27** http://www.gnu.org/copyleft/gpl.html.
28**
29** Other Usage
30** Alternatively, this file may be used in accordance with the terms and
31** conditions contained in a signed written agreement between you and Nokia.
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
49QT_BEGIN_HEADER
50
51QT_BEGIN_NAMESPACE
52
53QT_MODULE(Gui)
54
55class QColor;
56class QIODevice;
57class QRect;
58class QSize;
59class QStringList;
60
61class QImageReaderPrivate;
62class Q_GUI_EXPORT QImageReader
63{
64public:
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
138private:
139 Q_DISABLE_COPY(QImageReader)
140 QImageReaderPrivate *d;
141};
142
143QT_END_NAMESPACE
144
145QT_END_HEADER
146
147#endif // QIMAGEREADER_H
148