blob: 955e4cd4f216a8cc7b3503901a9c51aa3ac250a2 (
plain)
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
|
/****************************************************************************
**
** 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 list-of-language-items.html
\previouspage Scanner
\qmltype SubProject
\inqmlmodule QbsLanguageItems
\ingroup list-of-items
\keyword QML.SubProject
\brief Adds a project from a different file.
A SubProject item is used to add a sub-project that is defined in
a separate file. Additionally, properties of the sub-project can
be set without modifying the separate project file.
The following example adds a sub-project defined in
\c{subdir/project.qbs} and overrides its name.
\code
Project {
SubProject {
filePath: "subdir/project.qbs"
Properties {
name: "A sub-project"
}
}
...
}
\endcode
A typical use case for SubProject items is to conditionally
include sub-projects. The following example pulls in the \e{tests}
sub-project if and only if the \c{withTests} property is \c{true}.
\code
Project {
property bool withTests: false
SubProject {
filePath: "tests/tests.qbs"
Properties {
condition: parent.withTests
}
}
...
}
\endcode
If you do not need to set any properties on the sub-project, you can also
use the \l{Project::references}{Project.references} property, the same way
you would for a product.
\code
Project {
references: "subdir/project.qbs"
}
\endcode
is equivalent with
\code
Project {
SubProject {
filePath: "subdir/project.qbs"
}
}
\endcode
It is also possible to nest \l{Project} items directly in the same file.
*/
/*!
\qmlproperty bool SubProject::condition
Whether the sub-project is added. If \c false, the sub-project is not
included.
Setting this property has the same effect as setting the \c{condition}
property within a \l{Properties} item. If both this property and the
\c{condition} property within a \l{Properties} item are defined, the
sub-project is included only if both properties evaluate to \c{true}.
\defaultvalue \c true
*/
/*!
\qmlproperty path SubProject::filePath
The file path of the project to add as a sub-project. If the top-level item
in this file is a \l{Product}, it gets wrapped automatically in a new project.
\defaultvalue empty
*/
/*!
\qmlproperty bool SubProject::inheritProperties
Determines whether the sub-project should inherit the properties of the
surrounding \l{Project}. You can use this feature to share global
settings between projects and sub-projects.
\defaultvalue \c true
*/
|
