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 QPIXMAP_H
41#define QPIXMAP_H
42
43#include <QtGui/qtguiglobal.h>
44#include <QtGui/qpaintdevice.h>
45#include <QtGui/qcolor.h>
46#include <QtCore/qnamespace.h>
47#include <QtCore/qstring.h> // char*->QString conversion
48#include <QtCore/qsharedpointer.h>
49#include <QtGui/qimage.h>
50#include <QtGui/qtransform.h>
51
52QT_BEGIN_NAMESPACE
53
54
55class QImageWriter;
56class QImageReader;
57class QColor;
58class QVariant;
59class QPlatformPixmap;
60QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(QPlatformPixmap, Q_GUI_EXPORT)
61
62class Q_GUI_EXPORT QPixmap : public QPaintDevice
63{
64public:
65 QPixmap();
66 explicit QPixmap(QPlatformPixmap *data);
67 QPixmap(int w, int h);
68 explicit QPixmap(const QSize &);
69 QPixmap(const QString& fileName, const char *format = nullptr, Qt::ImageConversionFlags flags = Qt::AutoColor);
70#ifndef QT_NO_IMAGEFORMAT_XPM
71 explicit QPixmap(const char * const xpm[]);
72#endif
73 QPixmap(const QPixmap &);
74 QPixmap(QPixmap &&other) noexcept : QPaintDevice(), data(std::move(other.data)) {}
75 ~QPixmap();
76
77 QPixmap &operator=(const QPixmap &);
78 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_MOVE_AND_SWAP(QPixmap)
79 inline void swap(QPixmap &other) noexcept
80 { qSwap(data, other.data); }
81 bool operator==(const QPixmap &) const = delete;
82 bool operator!=(const QPixmap &) const = delete;
83
84 operator QVariant() const;
85
86 bool isNull() const;
87 int devType() const override;
88
89 int width() const;
90 int height() const;
91 QSize size() const;
92 QRect rect() const;
93 int depth() const;
94
95 static int defaultDepth();
96
97 void fill(const QColor &fillColor = Qt::white);
98
99 QBitmap mask() const;
100 void setMask(const QBitmap &);
101
102 qreal devicePixelRatio() const;
103 void setDevicePixelRatio(qreal scaleFactor);
104 QSizeF deviceIndependentSize() const;
105
106 bool hasAlpha() const;
107 bool hasAlphaChannel() const;
108
109#ifndef QT_NO_IMAGE_HEURISTIC_MASK
110 QBitmap createHeuristicMask(bool clipTight = true) const;
111#endif
112 QBitmap createMaskFromColor(const QColor &maskColor, Qt::MaskMode mode = Qt::MaskInColor) const;
113
114 inline QPixmap scaled(int w, int h, Qt::AspectRatioMode aspectMode = Qt::IgnoreAspectRatio,
115 Qt::TransformationMode mode = Qt::FastTransformation) const
116 { return scaled(QSize(w, h), aspectMode, mode); }
117 QPixmap scaled(const QSize &s, Qt::AspectRatioMode aspectMode = Qt::IgnoreAspectRatio,
118 Qt::TransformationMode mode = Qt::FastTransformation) const;
119 QPixmap scaledToWidth(int w, Qt::TransformationMode mode = Qt::FastTransformation) const;
120 QPixmap scaledToHeight(int h, Qt::TransformationMode mode = Qt::FastTransformation) const;
121 QPixmap transformed(const QTransform &, Qt::TransformationMode mode = Qt::FastTransformation) const;
122 static QTransform trueMatrix(const QTransform &m, int w, int h);
123
124 QImage toImage() const;
125 static QPixmap fromImage(const QImage &image, Qt::ImageConversionFlags flags = Qt::AutoColor);
126 static QPixmap fromImageReader(QImageReader *imageReader, Qt::ImageConversionFlags flags = Qt::AutoColor);
127 static QPixmap fromImage(QImage &&image, Qt::ImageConversionFlags flags = Qt::AutoColor)
128 {
129 return fromImageInPlace(image, flags);
130 }
131
132 bool load(const QString& fileName, const char *format = nullptr, Qt::ImageConversionFlags flags = Qt::AutoColor);
133 bool loadFromData(const uchar *buf, uint len, const char* format = nullptr, Qt::ImageConversionFlags flags = Qt::AutoColor);
134 inline bool loadFromData(const QByteArray &data, const char* format = nullptr, Qt::ImageConversionFlags flags = Qt::AutoColor);
135 bool save(const QString& fileName, const char* format = nullptr, int quality = -1) const;
136 bool save(QIODevice* device, const char* format = nullptr, int quality = -1) const;
137
138 bool convertFromImage(const QImage &img, Qt::ImageConversionFlags flags = Qt::AutoColor);
139
140 inline QPixmap copy(int x, int y, int width, int height) const;
141 QPixmap copy(const QRect &rect = QRect()) const;
142
143 inline void scroll(int dx, int dy, int x, int y, int width, int height, QRegion *exposed = nullptr);
144 void scroll(int dx, int dy, const QRect &rect, QRegion *exposed = nullptr);
145
146 qint64 cacheKey() const;
147
148 bool isDetached() const;
149 void detach();
150
151 bool isQBitmap() const;
152
153 QPaintEngine *paintEngine() const override;
154
155 inline bool operator!() const { return isNull(); }
156
157protected:
158 int metric(PaintDeviceMetric) const override;
159 static QPixmap fromImageInPlace(QImage &image, Qt::ImageConversionFlags flags = Qt::AutoColor);
160
161private:
162 QExplicitlySharedDataPointer<QPlatformPixmap> data;
163
164 bool doImageIO(QImageWriter *io, int quality) const;
165
166 QPixmap(const QSize &s, int type);
167 void doInit(int, int, int);
168 Q_DUMMY_COMPARISON_OPERATOR(QPixmap)
169 friend class QPlatformPixmap;
170 friend class QBitmap;
171 friend class QPaintDevice;
172 friend class QPainter;
173 friend class QOpenGLWidget;
174 friend class QWidgetPrivate;
175 friend class QRasterBuffer;
176#if !defined(QT_NO_DATASTREAM)
177 friend Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QPixmap &);
178#endif
179
180public:
181 QPlatformPixmap* handle() const;
182
183public:
184 typedef QExplicitlySharedDataPointer<QPlatformPixmap> DataPtr;
185 inline DataPtr &data_ptr() { return data; }
186};
187
188Q_DECLARE_SHARED(QPixmap)
189
190inline QPixmap QPixmap::copy(int ax, int ay, int awidth, int aheight) const
191{
192 return copy(QRect(ax, ay, awidth, aheight));
193}
194
195inline void QPixmap::scroll(int dx, int dy, int ax, int ay, int awidth, int aheight, QRegion *exposed)
196{
197 scroll(dx, dy, QRect(ax, ay, awidth, aheight), exposed);
198}
199
200inline bool QPixmap::loadFromData(const QByteArray &buf, const char *format,
201 Qt::ImageConversionFlags flags)
202{
203 return loadFromData(reinterpret_cast<const uchar *>(buf.constData()), buf.size(), format, flags);
204}
205
206
207/*****************************************************************************
208 QPixmap stream functions
209*****************************************************************************/
210
211#if !defined(QT_NO_DATASTREAM)
212Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QPixmap &);
213Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QPixmap &);
214#endif
215
216#ifndef QT_NO_DEBUG_STREAM
217Q_GUI_EXPORT QDebug operator<<(QDebug, const QPixmap &);
218#endif
219
220QT_END_NAMESPACE
221
222#endif // QPIXMAP_H
223