1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $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$
**
****************************************************************************/
/*!
\contentspage index.html
\qmltype Android.sdk
\inqmlmodule QbsModules
\since Qbs 1.4
\brief Provides support for building Android packages.
The Android.sdk module contains the properties and rules to create Android
application packages from Java sources, resources, and so on.
It is usually pulled in indirectly by declaring an \l Application product.
\section2 Relevant File Tags
\target filetags-android-sdk
\table
\header
\li Tag
\li Auto-tagged File Names
\li Since
\li Description
\row
\li \c{"android.aidl"}
\li \c{*.aidl}
\li 1.4.0
\li Attached to Android AIDL files. One Java source file will be
generated for each such file.
\row
\li \c{"android.assets"}
\li -
\li 1.4.0
\li Attached to Android assets, which are typically located in an
\c{assets/} subdirectory. These files are tagged automatically
if the \l automaticSources property is enabled.
\row
\li \c{"android.manifest"}
\li \c{AndroidManifest.xml}
\li 1.4.0
\li Attached to the Android manifest. There must be one such file for
every Android app.
\row
\li \c{"android.resources"}
\li -
\li 1.4.0
\li Attached to Android resources, which are typically located in a
\c{res/} subdirectory. These files are tagged automatically
if the \l automaticSources property is enabled.
\endtable
*/
/*!
\qmlproperty string Android.sdk::buildToolsVersion
The version of the build tools such as \c aapt and \c dx.
\defaultvalue Highest build tools version version available in the SDK.
*/
/*!
\qmlproperty string Android.sdk::ndkDir
The NDK base directory, if an NDK is present.
\defaultvalue Determined automatically based on standard search paths.
*/
/*!
\qmlproperty string Android.sdk::platform
The versioned platform name (for example, \c "android-21").
\defaultvalue Highest build tools version version available in the SDK.
*/
/*!
\qmlproperty string Android.sdk::sdkDir
The SDK base directory.
\defaultvalue Determined automatically based on standard search paths.
*/
/*!
\qmlproperty bool Android.sdk::embedJar
\since Qbs 1.10
If \c true, then if the dependency is a JAR file, its classes and the
classes of its dependencies (if \c{embedJar} is also true for them) will
be recursively processed by \c{dex} and included in the final APK.
\defaultvalue \c{true}
*/
/*!
\qmlproperty string Android.sdk::assetsDir
The base directory for Android assets in the respective product.
\note Android requires that the file name of this directory is always
\c "assets".
\defaultvalue \c "src/main/assets" in the product source directory
*/
/*!
\qmlproperty bool Android.sdk::automaticSources
If \c true, Java sources as well as Android resources, assets, and the
manifest file will be automatically included in the respective product
via wildcards. Set this property to \c false if you want to specify
these files manually.
\defaultvalue \c true
*/
/*!
\qmlproperty string Android.sdk::manifestFile
The file path to the Android manifest file.
This property is only relevant if \l automaticSources is enabled.
\note Android requires that the file name is always "AndroidManifest.xml".
\defaultvalue \c "src/main/AndroidManifest.xml" in the product source directory
*/
/*!
\qmlproperty string Android.sdk::packageName
The package name of the respective product. The \c package attribute in the manifest file
will be set to this value automatically.
\defaultvalue \c name
*/
/*!
\qmlproperty string Android.sdk::resourcesDir
The base directory for Android resources in the respective product.
\note Android requires that the file name of this directory is always
\c "res".
\defaultvalue \c "src/main/res" in the product source directory
*/
/*!
\qmlproperty path Android.sdk::sourcesDir
The base directory for Java sources. This property is only relevant if
\l automaticSources is enabled.
\defaultvalue \c "src/main/java" in the product source directory
*/
/*!
\qmlproperty string Android.sdk::apkBaseName
The base name of the APK file to to be built, that is, the file name
without the ".apk" extension.
\defaultvalue \l packageName
*/
/*!
\qmlproperty stringList Android.sdk::aidlSearchPaths
Search paths for import statements to pass to the \c aidl tool via the \c{-I} option.
*/
|
