Update copyright headers
[qt:qt.git] / doc / src / declarative / qmlsyntax.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file.  Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29 \page qmlsyntax.html
30 \title QML Syntax
31 \ingroup QML Reference
32 \contentspage QML Reference
33
34 \tableofcontents
35
36 QML is a declarative language designed to describe the user interface of a
37 program: both what it looks like, and how it behaves. In QML, a user
38 interface is specified as a tree of objects with properties.
39
40 JavaScript is used as a scripting language in QML, so you may want
41 to learn a bit more about it (\l{Javascript Guide}) before diving
42 deeper into QML.
43
44 \section1 Basic QML Syntax
45
46 QML looks like this:
47
48 \code
49 import QtQuick 1.0
50
51 Rectangle {
52     width: 200
53     height: 200
54     color: "blue"
55
56     Image {
57         source: "pics/logo.png"
58         anchors.centerIn: parent
59     }
60 }
61 \endcode
62
63 Objects are specified by their type, followed by a pair of braces. Object
64 types always begin with a capital letter. In the above example, there are
65 two objects, a \l Rectangle, and an \l Image. Between the braces, we can specify
66 information about the object, such as its properties.
67
68 Properties are specified as \c {propertyname: value}. In the above example, we
69 can see the Image has a property named \c source, which has been assigned the
70 value \c "pics/logo.png". The property and its value are separated by a colon.
71
72 Properties can be specified one-per-line:
73
74 \code
75 Rectangle {
76     width: 100
77     height: 100
78 }
79 \endcode
80
81 or you can put multiple properties on a single line:
82
83 \code
84 Rectangle { width: 100; height: 100 }
85 \endcode
86
87 When multiple property/value pairs are specified on a single line, they
88 must be separated by a semicolon.
89
90 The \c import statement imports the \c Qt \l{QML Modules}{module}, which contains all of the
91 standard \l {QML Elements}. Without this import statement, the \l Rectangle
92 and \l Image elements would not be available.
93
94 \section1 Expressions
95
96 In addition to assigning values to properties, you can also assign
97 expressions written in JavaScript.
98
99 \code
100 Rotation {
101     angle: 360 * 3
102 }
103 \endcode
104
105 These expressions can include references to other objects and properties, in which case
106 a \e binding is established: when the value of the expression changes, the property the
107 expression has been assigned to is automatically updated to that value.
108
109 \code
110 Item {
111     Text {
112         id: text1
113         text: "Hello World"
114     }
115     Text {
116         id: text2
117         text: text1.text
118     }
119 }
120 \endcode
121
122 In the example above, the \c text2 object will display the same text as \c text1. If \c text1 is changed,
123 \c text2 is automatically changed to the same value.
124
125 Note that to refer to other objects, we use their \e id values. (See below for more
126 information on the \e id property.)
127
128 \section1 QML Comments
129
130 Commenting in QML is similar to JavaScript.
131 \list
132 \o Single line comments start with // and finish at the end of the line.
133 \o Multiline comments start with /* and finish with *\/
134 \endlist
135
136 \snippet doc/src/snippets/declarative/comments.qml 0
137
138 Comments are ignored by the engine. They are useful for explaining what you
139 are doing; for referring back to at a later date, or for others reading
140 your QML files.
141
142 Comments can also be used to prevent the execution of code, which is
143 sometimes useful for tracking down problems.
144
145 \code
146 Text {
147     text: "Hello world!"
148     //opacity: 0.5
149 }
150 \endcode
151
152 In the above example, the Text object will have normal opacity, since the
153 line opacity: 0.5 has been turned into a comment.
154
155 */