qimagewriter.h [include/QtGui/qimagewriter.h]

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 QIMAGEWRITER_H
43	#define QIMAGEWRITER_H
44
45	#include <QtCore/qbytearray.h>
46	#include <QtCore/qlist.h>
47	#include <QtGui/qimageiohandler.h>
48
49	QT_BEGIN_HEADER
50
51	QT_BEGIN_NAMESPACE
52
53	QT_MODULE(Gui)
54
55	class QIODevice;
56	class QImage;
57
58	class QImageWriterPrivate;
59	class Q_GUI_EXPORT QImageWriter
60	{
61	public:
62	enum ImageWriterError {
63	UnknownError,
64	DeviceError,
65	UnsupportedFormatError
66	};
67
68	QImageWriter();
69	explicit QImageWriter(QIODevice device, const* QByteArray &format);
70	explicit QImageWriter(const QString &fileName, const QByteArray &format = QByteArray());
71	~QImageWriter();
72
73	void setFormat(const QByteArray &format);
74	QByteArray format() const;
75
76	void setDevice(QIODevice *device);
77	QIODevice device() const*;
78
79	void setFileName(const QString &fileName);
80	QString fileName() const;
81
82	void setQuality(int quality);
83	int quality() const;
84
85	void setCompression(int compression);
86	int compression() const;
87
88	void setGamma(float gamma);
89	float gamma() const;
90
91	// Obsolete as of 4.1
92	void setDescription(const QString &description);
93	QString description() const;
94
95	void setText(const QString &key, const QString &text);
96
97	bool canWrite() const;
98	bool write(const QImage &image);
99
100	ImageWriterError error() const;
101	QString errorString() const;
102
103	bool supportsOption(QImageIOHandler::ImageOption option) const;
104
105	static QList<QByteArray> supportedImageFormats();
106
107	private:
108	Q_DISABLE_COPY(QImageWriter)
109	QImageWriterPrivate *d;
110	};
111
112	QT_END_NAMESPACE
113
114	QT_END_HEADER
115
116	#endif // QIMAGEWRITER_H
117