Add 'cached' property to Image.

Task-number: QTBUG-7300
Reviewed-by: Aaron Kennedy

9 files changed, 96 insertions, 28 deletions

diff --git a/demos/declarative/photoviewer/PhotoViewerCore/PhotoDelegate.qml b/demos/declarative/photoviewer/PhotoViewerCore/PhotoDelegate.qml
index dadb409..d1f0755 100644
--- a/demos/declarative/photoviewer/PhotoViewerCore/PhotoDelegate.qml
+++ b/demos/declarative/photoviewer/PhotoViewerCore/PhotoDelegate.qml
@@ -88,11 +88,11 @@ Package {
             }
             BusyIndicator { anchors.centerIn: parent; on: originalImage.status != Image.Ready }
             Image {
-                id: originalImage; smooth: true; source: "http://" + Script.getImagePath(content)
+                id: originalImage; smooth: true; source: "http://" + Script.getImagePath(content); cached: false
                 fillMode: Image.PreserveAspectFit; width: photoWrapper.width; height: photoWrapper.height
             }
             Image {
-                id: hqImage; smooth: true; source: ""; visible: false
+                id: hqImage; smooth: true; source: ""; visible: false; cached: false
                 fillMode: Image.PreserveAspectFit; width: photoWrapper.width; height: photoWrapper.height
             }
             Binding {
diff --git a/src/declarative/graphicsitems/qdeclarativeborderimage.cpp b/src/declarative/graphicsitems/qdeclarativeborderimage.cpp
index f16770b..7299664 100644
--- a/src/declarative/graphicsitems/qdeclarativeborderimage.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeborderimage.cpp
@@ -211,7 +211,12 @@ void QDeclarativeBorderImage::load()
             }
         } else {
 
-            d->pix.load(qmlEngine(this), d->url, d->async);
+            QDeclarativePixmap::Options options;
+            if (d->async)
+                options |= QDeclarativePixmap::Asynchronous;
+            if (d->cached)
+                options |= QDeclarativePixmap::Cached;
+            d->pix.load(qmlEngine(this), d->url, options);
 
             if (d->pix.isLoading()) {
                 d->pix.connectFinished(this, SLOT(requestFinished()));
@@ -328,7 +333,12 @@ void QDeclarativeBorderImage::setGridScaledImage(const QDeclarativeGridScaledIma
 
         d->sciurl = d->url.resolved(QUrl(sci.pixmapUrl()));
 
-        d->pix.load(qmlEngine(this), d->sciurl, d->async);
+        QDeclarativePixmap::Options options;
+        if (d->async)
+            options |= QDeclarativePixmap::Asynchronous;
+        if (d->cached)
+            options |= QDeclarativePixmap::Cached;
+        d->pix.load(qmlEngine(this), d->sciurl, options);
 
         if (d->pix.isLoading()) {
             static int thisRequestProgress = -1;
diff --git a/src/declarative/graphicsitems/qdeclarativeimage.cpp b/src/declarative/graphicsitems/qdeclarativeimage.cpp
index 7a88e78..4ae0887 100644
--- a/src/declarative/graphicsitems/qdeclarativeimage.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeimage.cpp
@@ -414,6 +414,14 @@ void QDeclarativeImage::geometryChanged(const QRectF &newGeometry, const QRectF
     are always loaded asynchonously.
 */
 
+/*!
+    \qmlproperty bool Image::cached
+
+    Specifies that the image should be cached. The default value is
+    true. Setting \a cached to false is useful when dealing with large images,
+    to make sure that they aren't cached at the expense of small 'ui element' images.
+*/
+
 void QDeclarativeImage::paint(QPainter *p, const QStyleOptionGraphicsItem *, QWidget *)
 {
     Q_D(QDeclarativeImage);
diff --git a/src/declarative/graphicsitems/qdeclarativeimagebase.cpp b/src/declarative/graphicsitems/qdeclarativeimagebase.cpp
index 416604b..2fc935f 100644
--- a/src/declarative/graphicsitems/qdeclarativeimagebase.cpp
+++ b/src/declarative/graphicsitems/qdeclarativeimagebase.cpp
@@ -126,6 +126,24 @@ QSize QDeclarativeImageBase::sourceSize() const
     return d->sourcesize.isValid() ? d->sourcesize : QSize(implicitWidth(),implicitHeight());
 }
 
+bool QDeclarativeImageBase::cached() const
+{
+    Q_D(const QDeclarativeImageBase);
+    return d->cached;
+}
+
+void QDeclarativeImageBase::setCached(bool cached)
+{
+    Q_D(QDeclarativeImageBase);
+    if (d->cached == cached)
+        return;
+
+    d->cached = cached;
+    emit cachedChanged();
+    if (isComponentComplete())
+        load();
+}
+
 void QDeclarativeImageBase::load()
 {
     Q_D(QDeclarativeImageBase);
@@ -150,7 +168,12 @@ void QDeclarativeImageBase::load()
         d->status = Loading;
         emit statusChanged(d->status);
 
-        d->pix.load(qmlEngine(this), d->url, d->sourcesize, d->async);
+        QDeclarativePixmap::Options options;
+        if (d->async)
+            options |= QDeclarativePixmap::Asynchronous;
+        if (d->cached)
+            options |= QDeclarativePixmap::Cached;
+        d->pix.load(qmlEngine(this), d->url, d->sourcesize, options);
 
         if (d->pix.isLoading()) {
 
diff --git a/src/declarative/graphicsitems/qdeclarativeimagebase_p.h b/src/declarative/graphicsitems/qdeclarativeimagebase_p.h
index f5896b1..b6d2a44 100644
--- a/src/declarative/graphicsitems/qdeclarativeimagebase_p.h
+++ b/src/declarative/graphicsitems/qdeclarativeimagebase_p.h
@@ -58,7 +58,7 @@ class Q_AUTOTEST_EXPORT QDeclarativeImageBase : public QDeclarativeItem
     Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
     Q_PROPERTY(qreal progress READ progress NOTIFY progressChanged)
     Q_PROPERTY(bool asynchronous READ asynchronous WRITE setAsynchronous NOTIFY asynchronousChanged)
-
+    Q_PROPERTY(bool cached READ cached WRITE setCached NOTIFY cachedChanged)
     Q_PROPERTY(QSize sourceSize READ sourceSize WRITE setSourceSize NOTIFY sourceSizeChanged)
 
 public:
@@ -73,6 +73,9 @@ public:
     bool asynchronous() const;
     void setAsynchronous(bool);
 
+    bool cached() const;
+    void setCached(bool);
+
     virtual void setSourceSize(const QSize&);
     QSize sourceSize() const;
 
@@ -82,6 +85,7 @@ Q_SIGNALS:
     void statusChanged(Status);
     void progressChanged(qreal progress);
     void asynchronousChanged();
+    void cachedChanged();
 
 protected:
     virtual void load();
diff --git a/src/declarative/graphicsitems/qdeclarativeimagebase_p_p.h b/src/declarative/graphicsitems/qdeclarativeimagebase_p_p.h
index aee8b28..ba9f38f 100644
--- a/src/declarative/graphicsitems/qdeclarativeimagebase_p_p.h
+++ b/src/declarative/graphicsitems/qdeclarativeimagebase_p_p.h
@@ -69,7 +69,8 @@ public:
     QDeclarativeImageBasePrivate()
       : status(QDeclarativeImageBase::Null),
         progress(0.0),
-        async(false)
+        async(false),
+        cached(true)
     {
         QGraphicsItemPrivate::flags = QGraphicsItemPrivate::flags & ~QGraphicsItem::ItemHasNoContents;
     }
@@ -80,6 +81,7 @@ public:
     qreal progress;
     QSize sourcesize;
     bool async : 1;
+    bool cached : 1;
 };
 
 QT_END_NAMESPACE
diff --git a/src/declarative/util/qdeclarativepixmapcache.cpp b/src/declarative/util/qdeclarativepixmapcache.cpp
index de2de21..1177d07 100644
--- a/src/declarative/util/qdeclarativepixmapcache.cpp
+++ b/src/declarative/util/qdeclarativepixmapcache.cpp
@@ -956,20 +956,20 @@ QRect QDeclarativePixmap::rect() const
 
 void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url)
 {
-    load(engine, url, QSize(), false);
+    load(engine, url, QSize(), QDeclarativePixmap::Cached);
 }
 
-void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url, bool async)
+void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url, QDeclarativePixmap::Options options)
 {
-    load(engine, url, QSize(), async);
+    load(engine, url, QSize(), options);
 }
 
 void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url, const QSize &size)
 {
-    load(engine, url, size, false);
+    load(engine, url, size, QDeclarativePixmap::Cached);
 }
 
-void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url, const QSize &requestSize, bool async)
+void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url, const QSize &requestSize, QDeclarativePixmap::Options options)
 {
     if (d) { d->release(); d = 0; }
 
@@ -979,19 +979,20 @@ void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url, const
     QHash<QDeclarativePixmapKey, QDeclarativePixmapData *>::Iterator iter = store->m_cache.find(key);
 
     if (iter == store->m_cache.end()) {
-        if (async) {
+        if (options & QDeclarativePixmap::Asynchronous) {
             // pixmaps can only be loaded synchronously
             if (url.scheme() == QLatin1String("image") 
                     && QDeclarativeEnginePrivate::get(engine)->getImageProviderType(url) == QDeclarativeImageProvider::Pixmap) {
-                async = false;
+                options &= ~QDeclarativePixmap::Asynchronous;
             }
         }
 
-        if (!async) {
+        if (!(options & QDeclarativePixmap::Asynchronous)) {
             bool ok = false;
             d = createPixmapDataSync(engine, url, requestSize, &ok);
             if (ok) {
-                d->addToCache();
+                if (options & QDeclarativePixmap::Cached)
+                    d->addToCache();
                 return;
             }
             if (d)  // loadable, but encountered error while loading
@@ -1004,7 +1005,8 @@ void QDeclarativePixmap::load(QDeclarativeEngine *engine, const QUrl &url, const
         QDeclarativePixmapReader *reader = QDeclarativePixmapReader::instance(engine);
 
         d = new QDeclarativePixmapData(url, requestSize);
-        d->addToCache();
+        if (options & QDeclarativePixmap::Cached)
+            d->addToCache();
 
         d->reply = reader->getImage(d);
     } else {
diff --git a/src/declarative/util/qdeclarativepixmapcache_p.h b/src/declarative/util/qdeclarativepixmapcache_p.h
index b4d88bd..2c246c4 100644
--- a/src/declarative/util/qdeclarativepixmapcache_p.h
+++ b/src/declarative/util/qdeclarativepixmapcache_p.h
@@ -66,6 +66,12 @@ public:
 
     enum Status { Null, Ready, Error, Loading };
 
+    enum Option {
+        Asynchronous = 0x00000001,
+        Cached       = 0x00000002
+    };
+    Q_DECLARE_FLAGS(Options, Option)
+
     bool isNull() const;
     bool isReady() const;
     bool isError() const;
@@ -85,9 +91,9 @@ public:
     inline operator const QPixmap &() const;
 
     void load(QDeclarativeEngine *, const QUrl &);
-    void load(QDeclarativeEngine *, const QUrl &, bool);
+    void load(QDeclarativeEngine *, const QUrl &, QDeclarativePixmap::Options options);
     void load(QDeclarativeEngine *, const QUrl &, const QSize &);
-    void load(QDeclarativeEngine *, const QUrl &, const QSize &, bool);
+    void load(QDeclarativeEngine *, const QUrl &, const QSize &, QDeclarativePixmap::Options options);
 
     void clear();
     void clear(QObject *);
@@ -107,6 +113,8 @@ inline QDeclarativePixmap::operator const QPixmap &() const
     return pixmap();
 }
 
+Q_DECLARE_OPERATORS_FOR_FLAGS(QDeclarativePixmap::Options)
+
 QT_END_NAMESPACE
 
 QT_END_HEADER
diff --git a/tests/auto/declarative/qdeclarativeimage/tst_qdeclarativeimage.cpp b/tests/auto/declarative/qdeclarativeimage/tst_qdeclarativeimage.cpp
index 8cfb487..524736f 100644
--- a/tests/auto/declarative/qdeclarativeimage/tst_qdeclarativeimage.cpp
+++ b/tests/auto/declarative/qdeclarativeimage/tst_qdeclarativeimage.cpp
@@ -127,19 +127,21 @@ void tst_qdeclarativeimage::imageSource_data()
     QTest::addColumn<double>("height");
     QTest::addColumn<bool>("remote");
     QTest::addColumn<bool>("async");
+    QTest::addColumn<bool>("cached");
     QTest::addColumn<QString>("error");
 
-    QTest::newRow("local") << QUrl::fromLocalFile(SRCDIR "/data/colors.png").toString() << 120.0 << 120.0 << false << false << "";
-    QTest::newRow("local async") << QUrl::fromLocalFile(SRCDIR "/data/colors1.png").toString() << 120.0 << 120.0 << false << true << "";
+    QTest::newRow("local") << QUrl::fromLocalFile(SRCDIR "/data/colors.png").toString() << 120.0 << 120.0 << false << false << true << "";
+    QTest::newRow("local no cache") << QUrl::fromLocalFile(SRCDIR "/data/colors.png").toString() << 120.0 << 120.0 << false << false << false << "";
+    QTest::newRow("local async") << QUrl::fromLocalFile(SRCDIR "/data/colors1.png").toString() << 120.0 << 120.0 << false << true << true << "";
     QTest::newRow("local not found") << QUrl::fromLocalFile(SRCDIR "/data/no-such-file.png").toString() << 0.0 << 0.0 << false
-        << false << "file::2:1: QML Image: Cannot open: " + QUrl::fromLocalFile(SRCDIR "/data/no-such-file.png").toString();
+        << false << true << "file::2:1: QML Image: Cannot open: " + QUrl::fromLocalFile(SRCDIR "/data/no-such-file.png").toString();
     QTest::newRow("local async not found") << QUrl::fromLocalFile(SRCDIR "/data/no-such-file-1.png").toString() << 0.0 << 0.0 << false
-        << true << "file::2:1: QML Image: Cannot open: " + QUrl::fromLocalFile(SRCDIR "/data/no-such-file-1.png").toString();
-    QTest::newRow("remote") << SERVER_ADDR "/colors.png" << 120.0 << 120.0 << true << false << "";
-    QTest::newRow("remote redirected") << SERVER_ADDR "/oldcolors.png" << 120.0 << 120.0 << true << false << "";
-    QTest::newRow("remote svg") << SERVER_ADDR "/heart.svg" << 550.0 << 500.0 << true << false << "";
+        << true << true << "file::2:1: QML Image: Cannot open: " + QUrl::fromLocalFile(SRCDIR "/data/no-such-file-1.png").toString();
+    QTest::newRow("remote") << SERVER_ADDR "/colors.png" << 120.0 << 120.0 << true << false << true << "";
+    QTest::newRow("remote redirected") << SERVER_ADDR "/oldcolors.png" << 120.0 << 120.0 << true << false << false << "";
+    QTest::newRow("remote svg") << SERVER_ADDR "/heart.svg" << 550.0 << 500.0 << true << false << false << "";
     QTest::newRow("remote not found") << SERVER_ADDR "/no-such-file.png" << 0.0 << 0.0 << true
-        << false << "file::2:1: QML Image: Error downloading " SERVER_ADDR "/no-such-file.png - server replied: Not found";
+        << false << true << "file::2:1: QML Image: Error downloading " SERVER_ADDR "/no-such-file.png - server replied: Not found";
 
 }
 
@@ -150,6 +152,7 @@ void tst_qdeclarativeimage::imageSource()
     QFETCH(double, height);
     QFETCH(bool, remote);
     QFETCH(bool, async);
+    QFETCH(bool, cached);
     QFETCH(QString, error);
 
     TestHTTPServer server(SERVER_PORT);
@@ -163,7 +166,8 @@ void tst_qdeclarativeimage::imageSource()
         QTest::ignoreMessage(QtWarningMsg, error.toUtf8());
 
     QString componentStr = "import Qt 4.7\nImage { source: \"" + source + "\"; asynchronous: "
-        + (async ? QLatin1String("true") : QLatin1String("false")) + " }";
+        + (async ? QLatin1String("true") : QLatin1String("false")) + "; cached: "
+        + (cached ? QLatin1String("true") : QLatin1String("false")) + " }";
     QDeclarativeComponent component(&engine);
     component.setData(componentStr.toLatin1(), QUrl::fromLocalFile(""));
     QDeclarativeImage *obj = qobject_cast<QDeclarativeImage*>(component.create());
@@ -171,6 +175,13 @@ void tst_qdeclarativeimage::imageSource()
 
     if (async)
         QVERIFY(obj->asynchronous() == true);
+    else
+        QVERIFY(obj->asynchronous() == false);
+
+    if (cached)
+        QVERIFY(obj->cached() == true);
+    else
+        QVERIFY(obj->cached() == false);
 
     if (remote || async)
         TRY_WAIT(obj->status() == QDeclarativeImage::Loading);