summaryrefslogtreecommitdiffstats
path: root/src/android/templates/doc/src/android-manifest-file-configuration.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/android/templates/doc/src/android-manifest-file-configuration.qdoc')
-rw-r--r--src/android/templates/doc/src/android-manifest-file-configuration.qdoc127
1 files changed, 62 insertions, 65 deletions
diff --git a/src/android/templates/doc/src/android-manifest-file-configuration.qdoc b/src/android/templates/doc/src/android-manifest-file-configuration.qdoc
index 24faef4c7b..db0d3c7277 100644
--- a/src/android/templates/doc/src/android-manifest-file-configuration.qdoc
+++ b/src/android/templates/doc/src/android-manifest-file-configuration.qdoc
@@ -1,29 +1,5 @@
-/****************************************************************************
-**
-** Copyright (C) 2021 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://www.qt.io/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
+// Copyright (C) 2021 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page android-manifest-file-configuration.html
@@ -73,67 +49,74 @@ Qt sets the following manifest configuration by default:
\row
\li {1, 5} \l {Android: App Manifest <manifest>}{<manifest>}
\li package
- \li Sets the package name. Default: \c {org.qtproject.example.app_name}.
+ \li Sets the package name. The default value is \c {org.qtproject.example.app_name}.
\row
\li \c {android:installLocation}
\li Sets the app's installation location, whether internal or external storage.
- Default: \c auto.
+ The default value is \c auto.
\row
\li android:versionCode
\li Sets the internal version code. Populated from \c ANDROID_VERSION_CODE (qmake)
- and \c QT_ANDROID_VERSION_CODE (CMake). Default: \c 1.
+ and \c QT_ANDROID_VERSION_CODE (CMake). The default value is \c 1.
\row
\li android:versionName
\li Sets the public version name. Populated from \c ANDROID_VERSION_NAME (qmake)
- and \c QT_ANDROID_VERSION_NAME (CMake). Default: \c {1.0}.
+ and \c QT_ANDROID_VERSION_NAME (CMake). The default value is \c {1.0}.
\row
\li \c {<supports-screens>}
\li Sets the screen sizes that the app supports,
default values are \c anyDensity, \c largeScreens,
\c normalScreens, and \c smallScreens.
\row
- \li {1, 5} \l {Android: App Manifest <application>}{<application>}
+ \li {1, 6} \l {Android: App Manifest <application>}{<application>}
\li android:name
- \li The application class name. Default:
+ \li The application class name. Default value is
\c {org.qtproject.qt.android.bindings.QtApplication}.
\row
\li android:label
- \li The application name label. Default: the Qt project's target name.
-\row
- \li android:extractNativeLibs
- \li Extracts the native C++ libraries on installation. Default: \c true.
+ \li The application name label. Default value is the Qt project's target name.
\row
\li android:hardwareAccelerated
- \li Sets hardware acceleration preference. Default: \c true.
+ \li Sets hardware acceleration preference. The default value is \c true.
\row
\li android:requestLegacyExternalStorage
- \li Whether to use Android scoped storage. Default \c true.
+ \li Whether to use Android scoped storage. The default value is \c true.
+\row
+ \li android:allowBackup
+ \li Whether to allow the application to participate in the backup and restore
+ infrastructure. If this is set to \c false, no backup or restore of the
+ application will ever be performed. The default value is \c true.
+\row
+ \li android:fullBackupOnly
+ \li Whether or not to use Auto Backup on devices where it is available.
+ The default value is \c false.
\row
\li {1, 6} \l {Android: App Manifest <activity>}{<activity>}
\li android:name
- \li The activity class name. Default: \c {org.qtproject.qt.android.bindings.QtActivity}.
-\row
- \li android:label
- \li The activity name label. Default: the Qt project's target name.
+ \li The activity class name. The default value is \c {org.qtproject.qt.android.bindings.QtActivity}.
\row
\li android:configChanges
- \li Lists configuration changes that the activity handles. Default:
+ \li Lists configuration changes that the activity handles. Default value is
\c orientation, \c uiMode, \c screenLayout, \c screenSize,
\c smallestScreenSize, \c layoutDirection, \c locale, \c fontScale,
\c keyboard, \c keyboardHidden, \c navigation, \c mcc, \c mnc, \c density.
\row
\li android:launchMode
- \li The method used to launch the activity. Default: \c singleTop.
+ \li The method used to launch the activity. The default value is \c singleTop.
\row
\li android:screenOrientation
- \li The orientation of the activity's display on the device. Default: \c unspecified.
+ \li The orientation of the activity's display on the device. The default value is \c unspecified.
\row
\li <intent-filter>
- \li Specifies the types of intents that the activity can respond to. Default:
+ \li Specifies the types of intents that the activity can respond to. Default value is
\badcode
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
\endcode
+\row
+ \li android:exported
+ \li Sets whether the activity can be launched by components of other applications.
+ The default value is \c true.
\endtable
\section1 Qt Specific Meta-data
@@ -152,54 +135,51 @@ The following is a list of such meta-data defined by Qt:
\table
\header
- \li meta-data name
+ \li Meta-data Name
\li Description
\row
- \target android.app.lib_name
- \li android.app.lib_name
+ \li android.app.lib_name \target android.app.lib_name
\li The filename of the native C++ library that is used by the activity.
\note This attribute is mandatory and shouldn't be removed.
- Default: the Qt project's target name.
+ Default value is the Qt project's target name.
\row
\li android.app.extract_android_style
\li The method used to extract the native Android Style information.
For more information, see \l {Style Extraction}.
- Default: \c minimal.
+ The default value is \c minimal.
\row
- \target android.app.background_running
- \li android.app.background_running
+ \li android.app.background_running \target android.app.background_running
\li Sets whether the app keeps running tasks in the background.
Setting this to \c true is the equivalent of setting the environment
variable \c QT_BLOCK_EVENT_LOOPS_WHEN_SUSPENDED to \c 0.
- Default: \c false.
+ The default value is \c false.
\warning Setting this to \c true may cause unexpected crash if the
application tries to draw after \l {QGuiApplication::applicationStateChanged()}
signal is sent with a \l {Qt::ApplicationSuspended} state.
\row
- \target android.app.arguments
- \li android.app.arguments
+ \li android.app.arguments \target android.app.arguments
\li Sets a list of arguments to pass to the app \c {"arg1 arg2"}.
Populated from \c ANDROID_APPLICATION_ARGUMENTS (qmake) and
\c QT_ANDROID_APPLICATION_ARGUMENTS (CMake).
- Default: not set.
+ Default value is not set.
\row
\li android.app.splash_screen_drawable_portrait
\li Sets a drawable for a splash screen specific to portrait mode.
For example: \c {android:resource="@drawable/splash_portrait"}.
- Default: not set.
+ Default value is not set.
\row
\li android.app.splash_screen_drawable_landscape
\li Sets a drawable for a splash screen specific to landscape mode.
For example: \c {android:resource="@drawable/splash_landscape"}.
- Default: not set.
+ Default value is not set.
\row
\li android.app.splash_screen_drawable
\li Sets a drawable for a splash screen at the start of the app.
\note Orientation specific splash screens are checked first,
if not set, this is used instead.
For example: \c {android:resource="@drawable/splash"}.
- Default: not set.
+ Default value is not set.
\row
\li android.app.splash_screen_sticky
\li Sets whether the splash screen stays visible until explicitly hidden
@@ -207,11 +187,29 @@ The following is a list of such meta-data defined by Qt:
For more information, see
\l {QNativeInterface::}{QAndroidApplication::hideSplashScreen()}.
\row
- \target android.app.system_libs_prefix
- \li android.app.system_libs_prefix
+ \li android.app.trace_location
+ \li Specifies a location on device where the application can save tracing files.
+ For example: /storage/emulated/0/Android/data/<app_package_name>/files/.
+ This is needed when using Common Trace Format (CTF) tracing backend.
+ \note The application needs storage permission for the location.
+ Default: not set.
+\endtable
+
+\section2 Application Specific Meta-data
+
+Some meta-data attributes are application-wide, and should be placed under
+the \c <application> section:
+
+\table
+\header
+ \li Meta-data Name
+ \li Description
+\row
+ \li android.app.system_libs_prefix \target android.app.system_libs_prefix
\li Specifies a custom system library path to use for library loading lookup.
- This is necessary when running as a system app.
- Default: \c {/system/lib/}.
+ This is necessary when using Qt libraries installed outside an app's
+ default native (JNI) library directory.
+ The default value is \c {/system/lib/}.
\endtable
\section2 Meta-data in Services
@@ -223,7 +221,6 @@ The main ones are:
\li \l {android.app.lib_name}
\li \l {android.app.background_running}
\li \l {android.app.arguments}
- \li \l {android.app.system_libs_prefix}
\endlist
\section2 Qt Permissions and Features