From d204dd1d5e0f8399234ac1f804a1283457f393f2 Mon Sep 17 00:00:00 2001
From: Richard Moe Gustavsen <richard.gustavsen@theqtcompany.com>
Date: Mon, 11 May 2015 13:11:16 +0200
Subject: doc: add QStandardPaths documentation for iOS
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Task-number: QTBUG-36171
Change-Id: I15c5ac4f5c4944218e5f30c11530160f65699be9
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Samuel Gaist <samuel.gaist@edeltech.ch>
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@theqtcompany.com>
---
 src/corelib/io/qstandardpaths.cpp | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

(limited to 'src/corelib/io/qstandardpaths.cpp')

diff --git a/src/corelib/io/qstandardpaths.cpp b/src/corelib/io/qstandardpaths.cpp
index c5c596fd2e..74252d1f0a 100644
--- a/src/corelib/io/qstandardpaths.cpp
+++ b/src/corelib/io/qstandardpaths.cpp
@@ -275,45 +275,67 @@ QT_BEGIN_NAMESPACE
     \endtable
 
     \table
-    \header \li Path type \li Android
+    \header \li Path type \li Android \li iOS
     \row \li DesktopLocation
          \li "<APPROOT>/files"
+         \li "<APPROOT>/<APPDIR>" (not writable)
     \row \li DocumentsLocation
          \li "<USER>/Documents", "<USER>/<APPNAME>/Documents"
+         \li "<APPROOT>/Documents"
     \row \li FontsLocation
          \li "/system/fonts" (not writable)
+         \li "<APPROOT>/Documents/.fonts"
     \row \li ApplicationsLocation
          \li not supported (directory not readable)
+         \li not supported
     \row \li MusicLocation
          \li "<USER>/Music", "<USER>/<APPNAME>/Music"
+         \li "<APPROOT>/Documents/Music"
     \row \li MoviesLocation
          \li "<USER>/Movies", "<USER>/<APPNAME>/Movies"
+         \li "<APPROOT>/Documents/Movies"
     \row \li PicturesLocation
          \li "<USER>/Pictures", "<USER>/<APPNAME>/Pictures"
+         \li "<APPROOT>/Documents/Pictures", "assets-library://"
     \row \li TempLocation
          \li "<APPROOT>/cache"
+         \li "<APPROOT>/tmp"
     \row \li HomeLocation
          \li "<APPROOT>/files"
+         \li "<APPROOT>/<APPDIR>" (not writable)
     \row \li DataLocation
          \li "<APPROOT>/files", "<USER>/<APPNAME>/files"
+         \li "<APPROOT>/Library/Application Support"
     \row \li CacheLocation
          \li "<APPROOT>/cache", "<USER>/<APPNAME>/cache"
+         \li "<APPROOT>/Library/Caches"
     \row \li GenericDataLocation
          \li "<USER>"
+         \li "<APPROOT>/Documents"
     \row \li RuntimeLocation
          \li "<APPROOT>/cache"
+         \li not supported
     \row \li ConfigLocation
          \li "<APPROOT>/files/settings"
+         \li "<APPROOT>/Documents"
     \row \li GenericConfigLocation
          \li "<APPROOT>/files/settings" (there is no shared settings)
+         \li "<APPROOT>/Documents"
     \row \li DownloadLocation
          \li "<USER>/Downloads", "<USER>/<APPNAME>/Downloads"
+         \li "<APPROOT>/Documents/Download"
     \row \li GenericCacheLocation
          \li "<APPROOT>/cache" (there is no shared cache)
+         \li "<APPROOT>/Library/Caches"
     \row \li AppDataLocation
          \li "<APPROOT>/files", "<USER>/<APPNAME>/files"
+         \li "<APPROOT>/Library/Application Support"
     \row \li AppConfigLocation
          \li "<APPROOT>/files/settings"
+         \li "<APPROOT>/Documents"
+    \row \li AppLocalDataLocation
+         \li "<APPROOT>/files", "<USER>/<APPNAME>/files"
+         \li "<APPROOT>/Library/Application Support"
     \endtable
 
     In the table above, \c <APPNAME> is usually the organization name, the
@@ -328,6 +350,12 @@ QT_BEGIN_NAMESPACE
     \note On Android, applications with open files on the external storage (<USER> locations),
           will be killed if the external storage is unmounted.
 
+    \note On iOS, if you do pass \c {QStandardPaths::standardLocations(QStandardPaths::PicturesLocation).last()}
+        as argument to \l{QFileDialog::setDirectory()},
+        a native image picker dialog will be used for accessing the user's photo album.
+        The filename returned can be loaded using QFile and related APIs.
+        This feature was added in Qt 5.5.
+
     \sa writableLocation(), standardLocations(), displayName(), locate(), locateAll()
 */
 
-- 
cgit v1.2.3