Use #pragma warning(push) and pop to control our warnings
[qt:qtbase.git] / src / gui / image / qimage.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 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 QIMAGE_H
43 #define QIMAGE_H
44
45 #include <QtGui/qtransform.h>
46 #include <QtGui/qpaintdevice.h>
47 #include <QtGui/qrgb.h>
48 #include <QtCore/qbytearray.h>
49 #include <QtCore/qrect.h>
50 #include <QtCore/qstring.h>
51
52 #if QT_DEPRECATED_SINCE(5, 0)
53 #include <QtCore/qstringlist.h>
54 #endif
55
56 QT_BEGIN_NAMESPACE
57
58
59 class QIODevice;
60 class QStringList;
61 class QMatrix;
62 class QTransform;
63 class QVariant;
64 template <class T> class QList;
65 template <class T> class QVector;
66
67 struct QImageData;
68 class QImageDataMisc; // internal
69 #if QT_DEPRECATED_SINCE(5, 0)
70 class QImageTextKeyLang {
71 public:
72     QT_DEPRECATED QImageTextKeyLang(const char* k, const char* l) : key(k), lang(l) { }
73     QT_DEPRECATED QImageTextKeyLang() { }
74
75     QByteArray key;
76     QByteArray lang;
77
78     bool operator< (const QImageTextKeyLang& other) const
79         { return key < other.key || (key==other.key && lang < other.lang); }
80     bool operator== (const QImageTextKeyLang& other) const
81         { return key==other.key && lang==other.lang; }
82     inline bool operator!= (const QImageTextKeyLang &other) const
83         { return !operator==(other); }
84 private:
85     friend class QImage;
86     QImageTextKeyLang(bool /*dummy*/) {}
87 };
88 #endif
89
90 typedef void (*QImageCleanupFunction)(void*);
91
92 class Q_GUI_EXPORT QImage : public QPaintDevice
93 {
94 public:
95     enum InvertMode { InvertRgb, InvertRgba };
96     enum Format {
97         Format_Invalid,
98         Format_Mono,
99         Format_MonoLSB,
100         Format_Indexed8,
101         Format_RGB32,
102         Format_ARGB32,
103         Format_ARGB32_Premultiplied,
104         Format_RGB16,
105         Format_ARGB8565_Premultiplied,
106         Format_RGB666,
107         Format_ARGB6666_Premultiplied,
108         Format_RGB555,
109         Format_ARGB8555_Premultiplied,
110         Format_RGB888,
111         Format_RGB444,
112         Format_ARGB4444_Premultiplied,
113         Format_RGBX8888,
114         Format_RGBA8888,
115         Format_RGBA8888_Premultiplied,
116 #if 0
117         // reserved for future use
118         Format_RGB15,
119         Format_Grayscale16,
120         Format_Grayscale8,
121         Format_Grayscale4,
122         Format_Grayscale4LSB,
123         Format_Grayscale2,
124         Format_Grayscale2LSB
125 #endif
126 #ifndef Q_QDOC
127         NImageFormats
128 #endif
129     };
130
131     QImage();
132     QImage(const QSize &size, Format format);
133     QImage(int width, int height, Format format);
134     QImage(uchar *data, int width, int height, Format format, QImageCleanupFunction cleanupFunction = 0, void *cleanupInfo = 0);
135     QImage(const uchar *data, int width, int height, Format format, QImageCleanupFunction cleanupFunction = 0, void *cleanupInfo = 0);
136     QImage(uchar *data, int width, int height, int bytesPerLine, Format format, QImageCleanupFunction cleanupFunction = 0, void *cleanupInfo = 0);
137     QImage(const uchar *data, int width, int height, int bytesPerLine, Format format, QImageCleanupFunction cleanupFunction = 0, void *cleanupInfo = 0);
138
139 #ifndef QT_NO_IMAGEFORMAT_XPM
140     explicit QImage(const char * const xpm[]);
141 #endif
142     explicit QImage(const QString &fileName, const char *format = 0);
143
144     QImage(const QImage &);
145 #ifdef Q_COMPILER_RVALUE_REFS
146     inline QImage(QImage &&other)
147         : QPaintDevice(), d(0)
148     { qSwap(d, other.d); }
149 #endif
150     ~QImage();
151
152     QImage &operator=(const QImage &);
153 #ifdef Q_COMPILER_RVALUE_REFS
154     inline QImage &operator=(QImage &&other)
155     { qSwap(d, other.d); return *this; }
156 #endif
157     inline void swap(QImage &other) { qSwap(d, other.d); }
158
159     bool isNull() const;
160
161     int devType() const;
162
163     bool operator==(const QImage &) const;
164     bool operator!=(const QImage &) const;
165     operator QVariant() const;
166     void detach();
167     bool isDetached() const;
168
169     QImage copy(const QRect &rect = QRect()) const;
170     inline QImage copy(int x, int y, int w, int h) const
171         { return copy(QRect(x, y, w, h)); }
172
173     Format format() const;
174
175     QImage convertToFormat(Format f, Qt::ImageConversionFlags flags = Qt::AutoColor) const Q_REQUIRED_RESULT;
176     QImage convertToFormat(Format f, const QVector<QRgb> &colorTable, Qt::ImageConversionFlags flags = Qt::AutoColor) const Q_REQUIRED_RESULT;
177
178     int width() const;
179     int height() const;
180     QSize size() const;
181     QRect rect() const;
182
183     int depth() const;
184     int colorCount() const;
185     int bitPlaneCount() const;
186
187     QRgb color(int i) const;
188     void setColor(int i, QRgb c);
189     void setColorCount(int);
190
191     bool allGray() const;
192     bool isGrayscale() const;
193
194     uchar *bits();
195     const uchar *bits() const;
196     const uchar *constBits() const;
197
198     int byteCount() const;
199
200     uchar *scanLine(int);
201     const uchar *scanLine(int) const;
202     const uchar *constScanLine(int) const;
203     int bytesPerLine() const;
204
205     bool valid(int x, int y) const;
206     bool valid(const QPoint &pt) const;
207
208     int pixelIndex(int x, int y) const;
209     int pixelIndex(const QPoint &pt) const;
210
211     QRgb pixel(int x, int y) const;
212     QRgb pixel(const QPoint &pt) const;
213
214     void setPixel(int x, int y, uint index_or_rgb);
215     void setPixel(const QPoint &pt, uint index_or_rgb);
216
217     QVector<QRgb> colorTable() const;
218     void setColorTable(const QVector<QRgb> colors);
219
220     qreal devicePixelRatio() const;
221     void setDevicePixelRatio(qreal scaleFactor);
222
223     void fill(uint pixel);
224     void fill(const QColor &color);
225     void fill(Qt::GlobalColor color);
226
227
228     bool hasAlphaChannel() const;
229     void setAlphaChannel(const QImage &alphaChannel);
230     QImage alphaChannel() const;
231     QImage createAlphaMask(Qt::ImageConversionFlags flags = Qt::AutoColor) const;
232 #ifndef QT_NO_IMAGE_HEURISTIC_MASK
233     QImage createHeuristicMask(bool clipTight = true) const;
234 #endif
235     QImage createMaskFromColor(QRgb color, Qt::MaskMode mode = Qt::MaskInColor) const;
236
237     inline QImage scaled(int w, int h, Qt::AspectRatioMode aspectMode = Qt::IgnoreAspectRatio,
238                         Qt::TransformationMode mode = Qt::FastTransformation) const
239         { return scaled(QSize(w, h), aspectMode, mode); }
240     QImage scaled(const QSize &s, Qt::AspectRatioMode aspectMode = Qt::IgnoreAspectRatio,
241                  Qt::TransformationMode mode = Qt::FastTransformation) const;
242     QImage scaledToWidth(int w, Qt::TransformationMode mode = Qt::FastTransformation) const;
243     QImage scaledToHeight(int h, Qt::TransformationMode mode = Qt::FastTransformation) const;
244     QImage transformed(const QMatrix &matrix, Qt::TransformationMode mode = Qt::FastTransformation) const;
245     static QMatrix trueMatrix(const QMatrix &, int w, int h);
246     QImage transformed(const QTransform &matrix, Qt::TransformationMode mode = Qt::FastTransformation) const;
247     static QTransform trueMatrix(const QTransform &, int w, int h);
248     QImage mirrored(bool horizontally = false, bool vertically = true) const;
249     QImage rgbSwapped() const;
250     void invertPixels(InvertMode = InvertRgb);
251
252
253     bool load(QIODevice *device, const char* format);
254     bool load(const QString &fileName, const char* format=0);
255     bool loadFromData(const uchar *buf, int len, const char *format = 0);
256     inline bool loadFromData(const QByteArray &data, const char* aformat=0)
257         { return loadFromData(reinterpret_cast<const uchar *>(data.constData()), data.size(), aformat); }
258
259     bool save(const QString &fileName, const char* format=0, int quality=-1) const;
260     bool save(QIODevice *device, const char* format=0, int quality=-1) const;
261
262     static QImage fromData(const uchar *data, int size, const char *format = 0);
263     inline static QImage fromData(const QByteArray &data, const char *format = 0)
264         { return fromData(reinterpret_cast<const uchar *>(data.constData()), data.size(), format); }
265
266 #if QT_DEPRECATED_SINCE(5, 0)
267     QT_DEPRECATED inline int serialNumber() const { return cacheKey() >> 32; }
268 #endif
269     qint64 cacheKey() const;
270
271     QPaintEngine *paintEngine() const;
272
273     // Auxiliary data
274     int dotsPerMeterX() const;
275     int dotsPerMeterY() const;
276     void setDotsPerMeterX(int);
277     void setDotsPerMeterY(int);
278     QPoint offset() const;
279     void setOffset(const QPoint&);
280
281     QStringList textKeys() const;
282     QString text(const QString &key = QString()) const;
283     void setText(const QString &key, const QString &value);
284
285 #if QT_DEPRECATED_SINCE(5, 0)
286     QT_DEPRECATED inline QString text(const char* key, const char* lang=0) const;
287     QT_DEPRECATED inline QList<QImageTextKeyLang> textList() const;
288     QT_DEPRECATED inline QStringList textLanguages() const;
289     QT_DEPRECATED inline QString text(const QImageTextKeyLang&) const;
290     QT_DEPRECATED inline void setText(const char* key, const char* lang, const QString&);
291 #endif
292
293 #if QT_DEPRECATED_SINCE(5, 0)
294     QT_DEPRECATED inline int numColors() const;
295     QT_DEPRECATED inline void setNumColors(int);
296     QT_DEPRECATED inline int numBytes() const;
297 #endif
298
299 protected:
300     virtual int metric(PaintDeviceMetric metric) const;
301
302 private:
303     friend class QWSOnScreenSurface;
304     QImageData *d;
305
306     friend class QRasterPlatformPixmap;
307     friend class QBlittablePlatformPixmap;
308     friend class QPixmapCacheEntry;
309
310 public:
311     typedef QImageData * DataPtr;
312     inline DataPtr &data_ptr() { return d; }
313 };
314
315 Q_DECLARE_SHARED(QImage)
316
317 // Inline functions...
318
319 inline bool QImage::valid(const QPoint &pt) const { return valid(pt.x(), pt.y()); }
320 inline int QImage::pixelIndex(const QPoint &pt) const { return pixelIndex(pt.x(), pt.y());}
321 inline QRgb QImage::pixel(const QPoint &pt) const { return pixel(pt.x(), pt.y()); }
322 inline void QImage::setPixel(const QPoint &pt, uint index_or_rgb) { setPixel(pt.x(), pt.y(), index_or_rgb); }
323
324 #if QT_DEPRECATED_SINCE(5, 0)
325
326 #if defined(Q_CC_GNU) && !defined(Q_CC_INTEL) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 406)
327 # pragma GCC diagnostic push
328 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
329 #elif defined(Q_CC_MSVC)
330 # pragma warning(push)
331 # pragma warning(disable: 4996)
332 #endif
333
334 inline QString QImage::text(const char* key, const char* lang) const
335 {
336     if (!d)
337         return QString();
338     QString k = QString::fromLatin1(key);
339     if (lang && *lang)
340         k += QLatin1Char('/') + QString::fromLatin1(lang);
341     return text(k);
342 }
343
344 inline QList<QImageTextKeyLang> QImage::textList() const
345 {
346     QList<QImageTextKeyLang> imageTextKeys;
347     if (!d)
348         return imageTextKeys;
349     QStringList keys = textKeys();
350     for (int i = 0; i < keys.size(); ++i) {
351         int index = keys.at(i).indexOf(QLatin1Char('/'));
352         if (index > 0) {
353             QImageTextKeyLang tkl(true);
354             tkl.key = keys.at(i).left(index).toLatin1();
355             tkl.lang = keys.at(i).mid(index+1).toLatin1();
356             imageTextKeys += tkl;
357         }
358     }
359
360     return imageTextKeys;
361 }
362
363 inline QStringList QImage::textLanguages() const
364 {
365     if (!d)
366         return QStringList();
367     QStringList keys = textKeys();
368     QStringList languages;
369     for (int i = 0; i < keys.size(); ++i) {
370         int index = keys.at(i).indexOf(QLatin1Char('/'));
371         if (index > 0)
372             languages += keys.at(i).mid(index+1);
373     }
374
375     return languages;
376 }
377
378 inline QString QImage::text(const QImageTextKeyLang&kl) const
379 {
380     if (!d)
381         return QString();
382     QString k = QString::fromLatin1(kl.key.constData());
383     if (!kl.lang.isEmpty())
384         k += QLatin1Char('/') + QString::fromLatin1(kl.lang.constData());
385     return text(k);
386 }
387
388 inline void QImage::setText(const char* key, const char* lang, const QString &s)
389 {
390     if (!d)
391         return;
392     detach();
393
394     // In case detach() ran out of memory
395     if (!d)
396         return;
397
398     QString k = QString::fromLatin1(key);
399     if (lang && *lang)
400         k += QLatin1Char('/') + QString::fromLatin1(lang);
401     setText(k, s);
402 }
403
404 #if defined(Q_CC_GNU) && !defined(Q_CC_INTEL) && (__GNUC__ * 100 + __GNUC_MINOR__ >= 406)
405 # pragma GCC diagnostic pop
406 #elif defined(Q_CC_MSVC)
407 # pragma warning(pop)
408 #endif
409
410 inline int QImage::numColors() const
411 {
412     return colorCount();
413 }
414
415 inline void QImage::setNumColors(int n)
416 {
417     setColorCount(n);
418 }
419
420 inline int QImage::numBytes() const
421 {
422     return byteCount();
423 }
424 #endif
425
426 // QImage stream functions
427
428 #if !defined(QT_NO_DATASTREAM)
429 Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QImage &);
430 Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QImage &);
431 #endif
432
433 #ifndef QT_NO_DEBUG_STREAM
434 Q_GUI_EXPORT QDebug operator<<(QDebug, const QImage &);
435 #endif
436
437
438 QT_END_NAMESPACE
439
440 #endif // QIMAGE_H