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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in a
** written agreement between you and Nokia.
**
** GNU Free Documentation License
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qdeclarativebasictypes.html
\title QML Basic Types
QML has a set of primitive types, as listed below, that are used throughout
the \l {QML Elements}.
Some of these types can also be used for defining
\c property values in QML. See \l{Extending types from QML} for the
list of types that can be used for \c property values.
\annotatedlist qmlbasictypes
*/
/*!
\qmlbasictype int
\ingroup qmlbasictypes
\brief An integer is a whole number, e.g. 0, 10, or -20.
An integer is a whole number, e.g. 0, 10, or -20. The possible \c
int values range from around -2000000000 to around 2000000000,
although most elements will only accept a reduced range (which they
mention in their documentation).
Example:
\qml
Item { width: 100; height: 200 }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype bool
\ingroup qmlbasictypes
\brief A boolean is a binary true/false value.
A boolean is a binary true/false value.
Example:
\qml
Item { focus: true; clip: false }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype real
\ingroup qmlbasictypes
\brief A real number has a decimal point, e.g. 1.2 or -29.8.
A real number has a decimal point, e.g. 1.2 or -29.8.
Example:
\qml
Item { width: 100.45; height: 150.82 }
\endqml
\note In QML all reals are stored in single precision, \l
{http://en.wikipedia.org/wiki/IEEE_754} {IEEE floating point}
format.
\sa {QML Basic Types}
*/
/*!
\qmlbasictype string
\ingroup qmlbasictypes
\brief A string is a free form text in quotes, e.g. "Hello world!".
A string is a free form text in quotes, e.g. "Hello world!".
Example:
\qml
Text { text: "Hello world!" }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype url
\ingroup qmlbasictypes
\brief A URL is a resource locator, like a file name.
A URL is a resource locator, like a file name. It can be either
absolute, e.g. "http://qt.nokia.com", or relative, e.g.
"pics/logo.png". A relative URL is resolved relative to the URL of
the component where the URL is converted from a JavaScript string
expression to a url property value.
Example:
\qml
Image { source: "pics/logo.png" }
\endqml
\raw HTML
\endraw
\sa {QML Basic Types}
*/
/*!
\qmlbasictype color
\ingroup qmlbasictypes
\brief A color is a standard color name in quotes.
A color is a standard color name in quotes. It is normally specified
as an \l {http://www.w3.org/TR/SVG/types.html#ColorKeywords} {SVG
color name}. These names include colors like "red", "green" and
"lightsteelblue".
If the color you want isn't part of this list, colors can also be
specified in hexidecimal triplets or quads that take the form \c
"#RRGGBB" and \c "#AARRGGBB" respectively. For example, the color
red corresponds to a triplet of \c "#FF0000" and a slightly
transparent blue to a quad of \c "#800000FF".
Example:
\qml
Rectangle { color: "steelblue" }
Rectangle { color: "#FF0000" }
Rectangle { color: "#800000FF" }
\endqml
Or with the \l{QML:Qt::rgba()}{Qt.rgba()}, \l{QML:Qt::hsla()}{Qt.hsla()}, \l{QML:Qt::darker()}{Qt.darker()},
\l{QML:Qt::lighter()}{Qt.lighter()} or \l{QML:Qt::tint()}{Qt.tint()} functions:
\qml
Rectangle { color: Qt.rgba(255, 0, 0, 1) }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype point
\ingroup qmlbasictypes
\brief A point type has x and y attributes.
A \c point type has \c x and \c y attributes.
To create a \c point value, specify it as a "x,y" string:
\qml
CustomObject { myPointProperty: "0,20" }
\endqml
Or use the \l{QML:Qt::point()}{Qt.point()} function:
\qml
CustomObject { myPointProperty: Qt.point(0, 20) }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype size
\ingroup qmlbasictypes
\brief A size type has width and height attributes
A \c size type has \c width and \c height attributes.
For example, to read the \l {Image::sourceSize} \c size property:
\qml
Column {
Image { id: image; source: "logo.png" }
Text { text: image.sourceSize.width + "," + image.sourceSize.height }
}
\endqml
To create a \c size value, specify it as a "width x height" string:
\qml
LayoutItem { preferredSize: "150x50" }
\endqml
Or use the \l{QML:Qt::size()}{Qt.size()} function:
\qml
LayoutItem { preferredSize: Qt.size(150, 50) }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype rect
\ingroup qmlbasictypes
\brief A rect type has x, y, width and height attributes.
A \c rect type has \c x, \c y, \c width and \c height attributes.
For example, to read the \l {Item::childrenRect.x}{Item::childrenRect} \c rect property:
\qml
Rectangle {
width: childrenRect.width
height: childrenRect.height
Rectangle { width: 100; height: 100 }
}
\endqml
To create a \c rect value, specify it as a "x, y, width x height" string:
\qml
CustomObject { myRectProperty: "50,50,100x100" }
\endqml
Or use the \l{QML:Qt::rect()}{Qt.rect()} function:
\qml
CustomObject { myRectProperty: Qt.rect(50, 50, 100, 100) }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype date
\ingroup qmlbasictypes
\brief A date is specified as "YYYY-MM-DD".
To create a \c date value, specify it as a "YYYY-MM-DD" string:
Example:
\qml
MyDatePicker { minDate: "2000-01-01"; maxDate: "2020-12-31" }
\endqml
To read a date value returned from a C++ extension class, use
\l{QML:Qt::formatDate()}{Qt.formatDate()} and \l{QML:Qt::formatDateTime()}{Qt.formatDateTime()}.
\sa {QML Basic Types}
*/
/*!
\qmlbasictype time
\ingroup qmlbasictypes
\brief A time is specified as "hh:mm:ss".
A time is specified as "hh:mm:ss".
Example:
\qml
MyTimePicker { time: "14:22:15" }
\endqml
To read a time value returned from a C++ extension class, use
\l{QML:Qt::formatTime()}{Qt.formatTime()} and \l{QML:Qt::formatDateTime()}{Qt.formatDateTime()}.
\sa {QML Basic Types}
*/
/*!
\qmlbasictype font
\ingroup qmlbasictypes
\brief A font type has the properties of a QFont.
A font type has the properties of a QFont. The properties are:
\list
\o \c string font.family
\o \c bool font.bold
\o \c bool font.italic
\o \c bool font.underline
\o \c real font.pointSize
\o \c int font.pixelSize
\endlist
Example:
\qml
Text { font.family: "Helvetica"; font.pointSize: 13; font.bold: true }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype action
\ingroup qmlbasictypes
\brief The action type has all the properties of QAction.
The action type has all the properties of QAction. The properties
are:
\list
\o \c slot action.trigger - invoke the action
\o \c bool action.enabled - true if the action is enabled
\o \c string action.text - the text associated with the action
\endlist
Actions are used like this:
\qml
MouseArea { onClicked: myaction.trigger() }
State { name: "enabled"; when: myaction.enabled == true }
Text { text: someaction.text }
\endqml
\sa {QML Basic Types}
*/
/*!
\qmlbasictype list
\ingroup qmlbasictypes
\brief A list of objects.
A list of objects. While not technically a basic type, QML also
supports lists of object types. When used from QML, the engine
automatically appends each value to the list.
For example, the \l Item class contains a list property named
children that can be used like this:
\qml
Item {
children: [
Item { id: child1 },
Rectangle { id: child2 },
Text { id: child3 }
]
}
\endqml
\c child1, \c child2 and \c child3 will all be added to the children list
in the order in which they appear.
\sa {QML Basic Types}
*/
/*!
\qmlbasictype vector3d
\ingroup qmlbasictypes
\brief A vector3d type has x, y, and z attributes.
A \c vector3d type has \c x, \c y, and \c z attributes.
To create a \c vector3d value, specify it as a "x,y,z" string:
\qml
Rotation { angle: 60; axis: "0,1,0" }
\endqml
or with the \l{QML:Qt::vector3d()}{Qt.vector3d()} function:
\qml
Rotation { angle: 60; axis: Qt.vector3d(0, 1, 0) }
\endqml
or as separate \c x, \c y, and \c z components:
\qml
Rotation { angle: 60; axis.x: 0; axis.y: 1; axis.z: 0 }
\endqml
\sa {QML Basic Types}
*/
|