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 QtQuick 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 QQUICKIMAGE_P_H
41 #define QQUICKIMAGE_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists purely as an
48 // implementation detail.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include "qquickimagebase_p.h"
55 #include <QtQuick/qsgtextureprovider.h>
56 
57 QT_BEGIN_NAMESPACE
58 
59 class QQuickImagePrivate;
60 class Q_QUICK_PRIVATE_EXPORT QQuickImage : public QQuickImageBase
61 {
62     Q_OBJECT
63 
64     Q_PROPERTY(FillMode fillMode READ fillMode WRITE setFillMode NOTIFY fillModeChanged)
65     Q_PROPERTY(qreal paintedWidth READ paintedWidth NOTIFY paintedGeometryChanged)
66     Q_PROPERTY(qreal paintedHeight READ paintedHeight NOTIFY paintedGeometryChanged)
67     Q_PROPERTY(HAlignment horizontalAlignment READ horizontalAlignment WRITE setHorizontalAlignment NOTIFY horizontalAlignmentChanged)
68     Q_PROPERTY(VAlignment verticalAlignment READ verticalAlignment WRITE setVerticalAlignment NOTIFY verticalAlignmentChanged)
69     Q_PROPERTY(bool mipmap READ mipmap WRITE setMipmap NOTIFY mipmapChanged REVISION 3)
70     Q_PROPERTY(bool autoTransform READ autoTransform WRITE setAutoTransform NOTIFY autoTransformChanged REVISION 5)
71     Q_PROPERTY(QRectF sourceClipRect READ sourceClipRect WRITE setSourceClipRect RESET resetSourceClipRect NOTIFY sourceClipRectChanged REVISION 15)
72     QML_NAMED_ELEMENT(Image)
73 
74 public:
75     QQuickImage(QQuickItem *parent=nullptr);
76     ~QQuickImage();
77 
78     enum HAlignment { AlignLeft = Qt::AlignLeft,
79                        AlignRight = Qt::AlignRight,
80                        AlignHCenter = Qt::AlignHCenter };
81     Q_ENUM(HAlignment)
82     enum VAlignment { AlignTop = Qt::AlignTop,
83                        AlignBottom = Qt::AlignBottom,
84                        AlignVCenter = Qt::AlignVCenter };
85     Q_ENUM(VAlignment)
86 
87     enum FillMode { Stretch, PreserveAspectFit, PreserveAspectCrop, Tile, TileVertically, TileHorizontally, Pad };
88     Q_ENUM(FillMode)
89 
90     FillMode fillMode() const;
91     void setFillMode(FillMode);
92 
93     qreal paintedWidth() const;
94     qreal paintedHeight() const;
95 
96     QRectF boundingRect() const override;
97 
98     HAlignment horizontalAlignment() const;
99     void setHorizontalAlignment(HAlignment align);
100 
101     VAlignment verticalAlignment() const;
102     void setVerticalAlignment(VAlignment align);
103 
isTextureProvider()104     bool isTextureProvider() const override { return true; }
105     QSGTextureProvider *textureProvider() const override;
106 
107     bool mipmap() const;
108     void setMipmap(bool use);
109 
emitAutoTransformBaseChanged()110     void emitAutoTransformBaseChanged() override { emit autoTransformChanged(); }
111 
112 Q_SIGNALS:
113     void fillModeChanged();
114     void paintedGeometryChanged();
115     void horizontalAlignmentChanged(HAlignment alignment);
116     void verticalAlignmentChanged(VAlignment alignment);
117     Q_REVISION(3) void mipmapChanged(bool);
118     Q_REVISION(5) void autoTransformChanged();
119 
120 private Q_SLOTS:
121     void invalidateSceneGraph();
122 
123 protected:
124     QQuickImage(QQuickImagePrivate &dd, QQuickItem *parent);
125     void pixmapChange() override;
126     void updatePaintedGeometry();
127     void releaseResources() override;
128 
129     void geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry) override;
130     QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *) override;
131 
132 private:
133     Q_DISABLE_COPY(QQuickImage)
134     Q_DECLARE_PRIVATE(QQuickImage)
135 };
136 
137 QT_END_NAMESPACE
138 QML_DECLARE_TYPE(QQuickImage)
139 #endif // QQUICKIMAGE_P_H
140