diff options
Diffstat (limited to 'src/corelib/doc/src')
-rw-r--r-- | src/corelib/doc/src/cmake-macros.qdoc | 6 | ||||
-rw-r--r-- | src/corelib/doc/src/external-resources.qdoc | 30 | ||||
-rw-r--r-- | src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc | 13 | ||||
-rw-r--r-- | src/corelib/doc/src/includes/qfile-copy.qdocinc | 11 | ||||
-rw-r--r-- | src/corelib/doc/src/io.qdoc | 2 | ||||
-rw-r--r-- | src/corelib/doc/src/timers.qdoc | 6 |
6 files changed, 61 insertions, 7 deletions
diff --git a/src/corelib/doc/src/cmake-macros.qdoc b/src/corelib/doc/src/cmake-macros.qdoc index 8788554616..d595208449 100644 --- a/src/corelib/doc/src/cmake-macros.qdoc +++ b/src/corelib/doc/src/cmake-macros.qdoc @@ -406,11 +406,11 @@ This command was introduced in Qt 5.15. You can use \l qt5_import_plugins in old In the snippet above, the following occurs with the executable \c myapp: \list -\li The \c Qt::QCocoaIntegrationPlugin is imported into myapp. -\li The \c Qt::QMinimalIntegrationPlugin plugin is +\li The \c Qt5::QCocoaIntegrationPlugin is imported into myapp. +\li The \c Qt5::QMinimalIntegrationPlugin plugin is excluded from being automatically imported into myapp. \li The default list of plugins for \c imageformats is - overridden to only include Qt::QGifPlugin and Qt::QJpegPlugin. + overridden to only include Qt5::QGifPlugin and Qt5::QJpegPlugin. \li All \c sqldrivers plugins are excluded from automatic importing. \endlist */ diff --git a/src/corelib/doc/src/external-resources.qdoc b/src/corelib/doc/src/external-resources.qdoc index f16a21d521..0096bca948 100644 --- a/src/corelib/doc/src/external-resources.qdoc +++ b/src/corelib/doc/src/external-resources.qdoc @@ -65,3 +65,33 @@ \externalpage http://marcmutz.wordpress.com/effective-qt/containers/ \title Understand the Qt Containers */ + +/*! + \externalpage https://developer.android.com/training/data-storage/shared/documents-files + \title Android: Access documents and other files from shared storage +*/ + +/*! + \externalpage https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getParentFile() + \title Android: DocumentFile.getParentFile() +*/ + +/*! + \externalpage https://developer.android.com/guide/topics/providers/content-provider-basics#ContentURIs + \title Android: Content URIs +*/ + +/*! + \externalpage https://developer.android.com/training/data-storage#scoped-storage + \title Android: Scoped storage +*/ + +/*! + \externalpage https://developer.android.com/training/data-storage/use-cases + \title Android: storage best practices +*/ + +/*! + \externalpage https://developer.android.com/reference/android/provider/MediaStore + \title Android: MediaStore +*/ diff --git a/src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc b/src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc new file mode 100644 index 0000000000..f08086407e --- /dev/null +++ b/src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc @@ -0,0 +1,13 @@ +On Android, some limitations apply when dealing with +\l {Android: Content URIs}{content URIs}: +\list + \li Access permissions might be needed by prompting the user through the + \l QFileDialog which implements + \l {Access documents and other files from shared storage}{Android's native file picker}. + \li Aim to follow the \l {Android: Scoped storage}{Scoped storage} guidelines, + such as using app specific directories instead of other public external directories. + For more information, also see + \l {Android: storage best practices}{storage best practices}. + \li Due to the design of Qt APIs (e.g. QFile), it's not possible to fully + integrate the latter APIs with Android's \l {Android: MediaStore}{MediaStore} APIs. +\endlist diff --git a/src/corelib/doc/src/includes/qfile-copy.qdocinc b/src/corelib/doc/src/includes/qfile-copy.qdocinc new file mode 100644 index 0000000000..5ff68eac81 --- /dev/null +++ b/src/corelib/doc/src/includes/qfile-copy.qdocinc @@ -0,0 +1,11 @@ +This file is closed before it is copied. + +If the copied file is a symbolic link (symlink), the +file it refers to is copied, not the link itself. With the +exception of permissions, which are copied, no other file metadata +is copied. + +Returns \c true if successful; otherwise returns \c false. + +Note that if a file with the name \a newName already exists, +copy() returns \c false. This means QFile will not overwrite it. diff --git a/src/corelib/doc/src/io.qdoc b/src/corelib/doc/src/io.qdoc index a1bbc623a1..6315a069aa 100644 --- a/src/corelib/doc/src/io.qdoc +++ b/src/corelib/doc/src/io.qdoc @@ -34,7 +34,7 @@ network handling. These \l{Qt Core} classes are used to handle input and output to and from - external devices, processes, files etc. as well as manipulating files and + external devices, processes, files etc., as well as manipulating files and directories. */ diff --git a/src/corelib/doc/src/timers.qdoc b/src/corelib/doc/src/timers.qdoc index 1fa62a6afb..f54d2fa457 100644 --- a/src/corelib/doc/src/timers.qdoc +++ b/src/corelib/doc/src/timers.qdoc @@ -65,14 +65,14 @@ The main API for the timer functionality is QTimer. That class provides regular timers that emit a signal when the timer fires, and inherits QObject so that it fits well into the ownership structure - of most GUI programs. The normal way of using it is like this: + of most Qt programs. The normal way of using it is like this: \snippet timers/timers.cpp 0 \snippet timers/timers.cpp 1 \snippet timers/timers.cpp 2 - The QTimer object is made into a child of this widget so that, - when this widget is deleted, the timer is deleted too. + The QTimer object is made into a child of \c this object so that, + when \c this object is deleted, the timer is deleted too. Next, its \l{QTimer::}{timeout()} signal is connected to the slot that will do the work, it is started with a value of 1000 milliseconds, indicating that it will time out every second. |