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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
/****************************************************************************
**
** 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 ib
\inqmlmodule QbsModules
\since Qbs 1.1
\brief Provides support for Apple Interface Builder and related tools and file types.
The \c ib module contains properties and rules for building Interface Builder documents,
storyboards, asset catalogs, and icon sets.
This module is only available on Apple platforms.
\section2 Relevant File Tags
\target filetags-ib
The file tags determine how the tagged directories and files are handled.
\table
\header
\li Tag
\li Auto-tagged File Names
\li Since
\li Description
\row
\li \c{"assetcatalog"}
\li \c{*.xcassets}
\li 1.3
\li Tagged directories are compiled into compiled asset catalog
archives (\c .car files) on supported platforms, or a collection of
loose resource files. The resulting files will be automatically
tagged \l{filetags-bundle}{bundle.input}. If the current product is
a bundle, the files will be included in the bundle's resources
directory.
\row
\li \c{"iconset"}
\li \c{*.iconset}
\li 1.3
\li Tagged directories are compiled into Apple ICNS files. The resulting
files will be automatically tagged \l{filetags-bundle}
{bundle.input}. If the current product is a bundle, the files will
be included in the bundle's resources directory.
\row
\li \c{"nib"}
\li \c{*.nib}, \c{*.xib}
\li 1.1
\li Tagged "NIB" and "XIB" files will be compiled. The output may be a
flat file or a bundle (directory structure). The resulting
files will be automatically tagged \l{filetags-bundle}
{bundle.input}. If the current product is a bundle, the files will
be included in the bundle's resources directory.
\row
\li \c{"png"}
\li \c{*.png}
\li 1.9
\li Tagged PNG files may be converted into multi-resolution TIFFs.
Source files should adopt the \l{Adopt the @2x Naming Convention}
{@2x naming convention} in order to be properly grouped. The
resulting files will be given the \l{filetags-dmg}{tiff} file tag.
\row
\li \c{"storyboard"}
\li \c{*.storyboard}
\li 1.3
\li Tagged storyboard files will be compiled. The output may be a flat
file or a bundle (directory structure). The resulting
files will be automatically tagged \l{filetags-bundle}
{bundle.input}. If the current product is a bundle, the files will
be included in the bundle's resources directory.
\endtable
*/
/*!
\qmlproperty bool ib::warnings
Whether to print warnings when compiling.
Does not apply to icon sets.
\defaultvalue \c{true}
*/
/*!
\qmlproperty bool ib::errors
Whether to print errors when compiling.
Does not apply to icon sets.
\defaultvalue \c{true}
*/
/*!
\qmlproperty bool ib::notices
Whether to print notifications when compiling.
Does not apply to icon sets.
\defaultvalue \c{true}
*/
/*!
\qmlproperty stringList ib::flags
Additional flags to pass to the underlying tool (\c ibtool, \c actool,
\c iconutil).
\nodefaultvalue
\defaultvalue \c{true}
*/
/*!
\qmlproperty string ib::ibtoolName
\since Qbs 1.3
The name of the \c ibtool binary used to compile NIBs and storyboards.
This property should not normally need to be changed.
\defaultvalue \c{"ibtool"}
*/
/*!
\qmlproperty string ib::ibtoolPath
\since Qbs 1.3
The directory where the \c ibtool binary is located.
This property should not normally need to be changed.
\defaultvalue \c{ibtoolName}
*/
/*!
\qmlproperty bool ib::flatten
Compiles XIBs and storyboards into flattened (non-wrapper) files.
Set to \c{false} to preserve editability of the resulting NIB and storyboard
bundles in Interface Builder.
This property should not normally need to be changed.
\defaultvalue \c{true}
*/
/*!
\qmlproperty string ib::module
\since Qbs 1.3
Sets the name of the module that the NIB or storyboard is a part of.
Requires Xcode 6 or newer.
\nodefaultvalue
*/
/*!
\qmlproperty bool ib::autoActivateCustomFonts
\since Qbs 1.3
Instructs the \c ibtool compiler to add custom fonts to the application's
\c Info.plist when compiling XIBs and storyboards, which will cause the
fonts to activate upon application launch.
Requires Xcode 6 or newer.
\defaultvalue \c{true}
*/
/*!
\qmlproperty string ib::actoolName
\since Qbs 1.3
The name of the \c actool binary used to compile asset catalogs.
This property should not normally need to be changed.
\defaultvalue \c{"actool"}
*/
/*!
\qmlproperty string ib::actoolPath
\since Qbs 1.3
The directory where the \c actool binary is located.
This property should not normally need to be changed.
\defaultvalue \c{actoolName}
*/
/*!
\qmlproperty string ib::appIconName
\since Qbs 1.3
The name of the resource in the asset catalog that will be used as the
application's icon.
Used to generate the partial \c Info.plist which will be merged into the
resulting app.
If this property is \c{undefined}, no application icon will be specified.
\nodefaultvalue
*/
/*!
\qmlproperty string ib::launchImageName
\since Qbs 1.3
The name of the resource in the asset catalog that will be used as the
application's launch image.
Used to generate the partial \c Info.plist which will be merged into the
resulting app.
If this property is \c{undefined}, no launch image will be specified.
This property is specific to iOS.
\nodefaultvalue
*/
/*!
\qmlproperty bool ib::compressPngs
\since Qbs 1.3
Whether to compress PNG image files when building asset catalogs.
\defaultvalue \c{true}
*/
/*!
\qmlproperty string ib::iconutilName
\since Qbs 1.3
The name of the \c iconutil binary used to compile icon sets.
This property should not normally need to be changed.
\defaultvalue \c{"iconutil"}
*/
/*!
\qmlproperty string ib::iconutilPath
\since Qbs 1.3
The directory where the \c iconutil binary is located.
This property should not normally need to be changed.
\defaultvalue \c{iconutilName}
*/
|
