1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2016 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 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 The Qt Company. For licensing terms 14 ** and conditions see https://www.qt.io/terms-conditions. For further 15 ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software 20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the 21 ** packaging of this file. Please review the following information to 22 ** ensure the GNU Lesser General Public License version 3 requirements 23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. 24 ** 25 ** GNU General Public License Usage 26 ** Alternatively, this file may be used under the terms of the GNU 27 ** General Public License version 2.0 or (at your option) the GNU General 28 ** Public license version 3 or any later version approved by the KDE Free 29 ** Qt Foundation. The licenses are as published by the Free Software 30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 31 ** included in the packaging of this file. Please review the following 32 ** information to ensure the GNU General Public License requirements will 33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and 34 ** https://www.gnu.org/licenses/gpl-3.0.html. 35 ** 36 ** $QT_END_LICENSE$ 37 ** 38 ****************************************************************************/ 39 40 #ifndef QIMAGEWRITER_H 41 #define QIMAGEWRITER_H 42 43 #include <QtGui/qtguiglobal.h> 44 #include <QtCore/qbytearray.h> 45 #include <QtCore/qcoreapplication.h> 46 #include <QtCore/qlist.h> 47 #include <QtGui/qimageiohandler.h> 48 49 QT_BEGIN_NAMESPACE 50 51 52 class QIODevice; 53 class QImage; 54 55 class QImageWriterPrivate; 56 class Q_GUI_EXPORT QImageWriter 57 { 58 Q_DECLARE_TR_FUNCTIONS(QImageWriter) 59 public: 60 enum ImageWriterError { 61 UnknownError, 62 DeviceError, 63 UnsupportedFormatError, 64 InvalidImageError 65 }; 66 67 QImageWriter(); 68 explicit QImageWriter(QIODevice *device, const QByteArray &format); 69 explicit QImageWriter(const QString &fileName, const QByteArray &format = QByteArray()); 70 ~QImageWriter(); 71 72 void setFormat(const QByteArray &format); 73 QByteArray format() const; 74 75 void setDevice(QIODevice *device); 76 QIODevice *device() const; 77 78 void setFileName(const QString &fileName); 79 QString fileName() const; 80 81 void setQuality(int quality); 82 int quality() const; 83 84 void setCompression(int compression); 85 int compression() const; 86 87 #if QT_DEPRECATED_SINCE(5, 15) 88 QT_DEPRECATED_VERSION_X_5_15("Use QColorSpace instead") 89 void setGamma(float gamma); 90 QT_DEPRECATED_VERSION_X_5_15("Use QColorSpace instead") 91 float gamma() const; 92 #endif 93 94 void setSubType(const QByteArray &type); 95 QByteArray subType() const; 96 QList<QByteArray> supportedSubTypes() const; 97 98 void setOptimizedWrite(bool optimize); 99 bool optimizedWrite() const; 100 101 void setProgressiveScanWrite(bool progressive); 102 bool progressiveScanWrite() const; 103 104 QImageIOHandler::Transformations transformation() const; 105 void setTransformation(QImageIOHandler::Transformations orientation); 106 107 #if QT_DEPRECATED_SINCE(5, 13) 108 QT_DEPRECATED_X("Use QImageWriter::setText() instead") 109 void setDescription(const QString &description); 110 QT_DEPRECATED_X("Use QImageReader::text() instead") 111 QString description() const; 112 #endif 113 114 void setText(const QString &key, const QString &text); 115 116 bool canWrite() const; 117 bool write(const QImage &image); 118 119 ImageWriterError error() const; 120 QString errorString() const; 121 122 bool supportsOption(QImageIOHandler::ImageOption option) const; 123 124 static QList<QByteArray> supportedImageFormats(); 125 static QList<QByteArray> supportedMimeTypes(); 126 static QList<QByteArray> imageFormatsForMimeType(const QByteArray &mimeType); 127 128 private: 129 Q_DISABLE_COPY(QImageWriter) 130 QImageWriterPrivate *d; 131 }; 132 133 QT_END_NAMESPACE 134 135 #endif // QIMAGEWRITER_H 136