Clarify case preservation in QDeclarativeImageProviders

Task-number: QTBUG-15905
Reviewed-by: Martin Jones

2 files changed, 11 insertions, 1 deletions

diff --git a/src/declarative/qml/qdeclarativeengine.cpp b/src/declarative/qml/qdeclarativeengine.cpp
index 890f500..37df226 100644
--- a/src/declarative/qml/qdeclarativeengine.cpp
+++ b/src/declarative/qml/qdeclarativeengine.cpp
@@ -776,7 +776,7 @@ void QDeclarativeEngine::addImageProvider(const QString &providerId, QDeclarativ
 {
     Q_D(QDeclarativeEngine);
     QMutexLocker locker(&d->mutex);
-    d->imageProviders.insert(providerId, QSharedPointer<QDeclarativeImageProvider>(provider));
+    d->imageProviders.insert(providerId.toLower(), QSharedPointer<QDeclarativeImageProvider>(provider));
 }
 
 /*!
diff --git a/src/declarative/qml/qdeclarativeimageprovider.cpp b/src/declarative/qml/qdeclarativeimageprovider.cpp
index 560077f..f111c20 100644
--- a/src/declarative/qml/qdeclarativeimageprovider.cpp
+++ b/src/declarative/qml/qdeclarativeimageprovider.cpp
@@ -75,6 +75,16 @@ public:
     invokes the appropriate image provider according to the providers that have
     been registered through QDeclarativeEngine::addImageProvider().
 
+    Note that the identifiers are case-insensitive, but the rest of the URL will be passed on with
+    preserved case. For example, the below snippet would still specify that the image is loaded by the
+    image provider named "myimageprovider", but it would request a different image than the above snippet
+    ("Image.png" instead of "image.png").
+    \qml
+    Image { source: "image://MyImageProvider/Image.png" }
+    \endqml
+
+    If you want the rest of the URL to be case insensitive, you will have to take care
+    of that yourself inside your image provider.
 
     \section2 An example