QtGui/qimagereader.h Source File

qimagereader.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
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 
50 
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:
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 
144 
146 
147 #endif // QIMAGEREADER_H
#define QT_END_NAMESPACE
Definition: qglobal.h:128
#define QT_BEGIN_HEADER
Definition: qglobal.h:141
Definition: qcolor.h:67
GLXDrawable GLXDrawable read
Definition: GLee.h:10243
GLenum GLsizei GLenum GLenum const GLvoid * image
Definition: GLee.h:882
#define QT_BEGIN_NAMESPACE
Definition: qglobal.h:127
GLenum GLsizei GLenum format
Definition: GLee.h:873
Definition: qimage.h:87
Format
Definition: qimage.h:91
Definition: qrect.h:58
Definition: qsize.h:53
#define QT_END_HEADER
Definition: qglobal.h:142
GLsizeiptr size
Definition: GLee.h:1561
GLuint color
Definition: GLee.h:8456