summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Strømme <christian.stromme@digia.com>2013-11-07 00:54:33 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-01-23 17:59:30 +0100
commit3d7d710424056a3c8a4062da234821acd91ee0af (patch)
tree21976fa51e7f5589369ff10b8f0b427115ce0e81
parent382faed8c78335fe44828aee8ca6c0284bb9c9f7 (diff)
Update QStandardPaths documentation with Android paths.
Adds example paths for the various locations returned on Android. Change-Id: I55a4e23570c252cbf643596d166c7c43f023ba9c Reviewed-by: BogDan Vatra <bogdan@kde.org> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
-rw-r--r--src/corelib/io/qstandardpaths.cpp43
1 files changed, 42 insertions, 1 deletions
diff --git a/src/corelib/io/qstandardpaths.cpp b/src/corelib/io/qstandardpaths.cpp
index c145ec4bad..bd9fa68d93 100644
--- a/src/corelib/io/qstandardpaths.cpp
+++ b/src/corelib/io/qstandardpaths.cpp
@@ -203,7 +203,7 @@ QT_BEGIN_NAMESPACE
\endtable
\table
- \header \li Path type \li Blackberry \li Linux (including Android)
+ \header \li Path type \li Blackberry \li Linux
\row \li DesktopLocation
\li "<APPROOT>/data"
\li "~/Desktop"
@@ -257,6 +257,44 @@ QT_BEGIN_NAMESPACE
\li "~/.cache"
\endtable
+ \table
+ \header \li Path type \li Android
+ \row \li DesktopLocation
+ \li "<APPROOT>/files"
+ \row \li DocumentsLocation
+ \li "<USER>/Documents", "<USER>/<APPNAME>/Documents"
+ \row \li FontsLocation
+ \li "/system/fonts" (not writable)
+ \row \li ApplicationsLocation
+ \li not supported (directory not readable)
+ \row \li MusicLocation
+ \li "<USER>/Music", "<USER>/<APPNAME>/Music"
+ \row \li MoviesLocation
+ \li "<USER>/Movies", "<USER>/<APPNAME>/Movies"
+ \row \li PicturesLocation
+ \li "<USER>/Pictures", "<USER>/<APPNAME>/Pictures"
+ \row \li TempLocation
+ \li "<APPROOT>/cache"
+ \row \li HomeLocation
+ \li "<APPROOT>/files"
+ \row \li DataLocation
+ \li "<APPROOT>/files", "<USER>/<APPNAME>/files"
+ \row \li CacheLocation
+ \li "<APPROOT>/cache", "<USER>/<APPNAME>/cache"
+ \row \li GenericDataLocation
+ \li "<USER>"
+ \row \li RuntimeLocation
+ \li "<APPROOT>/cache"
+ \row \li ConfigLocation
+ \li "<APPROOT>/files/settings"
+ \row \li GenericConfigLocation
+ \li "<APPROOT>/files/settings" (there is no shared settings)
+ \row \li DownloadLocation
+ \li "<USER>/Downloads", "<USER>/<APPNAME>/Downloads"
+ \row \li GenericCacheLocation
+ \li "<APPROOT>/cache" (there is no shared cache)
+ \endtable
+
In the table above, \c <APPNAME> is usually the organization name, the
application name, or both, or a unique name generated at packaging.
Similarly, <APPROOT> is the location where this application is installed
@@ -266,6 +304,9 @@ QT_BEGIN_NAMESPACE
The paths above should not be relied upon, as they may change according to
OS configuration, locale, or they may change in future Qt versions.
+ \note On Android, applications with open files on the external storage (<USER> locations),
+ will be killed if the external storage is unmounted.
+
\sa writableLocation(), standardLocations(), displayName(), locate(), locateAll()
*/