Doc: Adding list of JavaScript functions in QML.
[profile/ivi/qtdeclarative.git] / doc / src / qml / jsfunctionlist.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** GNU Free Documentation License
10 ** Alternatively, this file may be used under the terms of the GNU Free
11 ** Documentation License version 1.3 as published by the Free Software
12 ** Foundation and appearing in the file included in the packaging of
13 ** this file.
14 **
15 ** Other Usage
16 ** Alternatively, this file may be used in accordance with the terms
17 ** and conditions contained in a signed written agreement between you
18 ** and Nokia.
19 **
20 **
21 **
22 **
23 **
24 ** $QT_END_LICENSE$
25 **
26 ****************************************************************************/
27
28 /*!
29     \page jsfunctionlist.html
30     \title List of JavaScript Objects and Functions
31     \brief A list of objects, functions, and properties supported in QML.
32
33     This reference contains a list of objects, functions and
34     properties supported by the \l{The QML Engine}{QML engine}. For a detailed
35     description, see the \l{External: ECMA-262} specification.
36
37     \section1 The Global Object
38
39     \section2 Value Properties
40
41     \list
42     \li NaN
43     \li Infinity
44     \li undefined
45     \endlist
46
47     \section2 Function Properties
48
49     \list
50     \li eval(x)
51     \li parseInt(string, radix)
52     \li parseFloat(string)
53     \li isNaN(number)
54     \li isFinite(number)
55     \li decodeURI(encodedURI)
56     \li decodeURIComponent(encodedURIComponent)
57     \li encodeURI(uri)
58     \li encodeURIComponent(uriComponent)
59     \endlist
60
61     \section2 Constructor Properties
62
63     \list
64     \li Object
65     \li Function
66     \li Array
67     \li String
68     \li Boolean
69     \li Number
70     \li Date
71     \li RegExp
72     \li Error
73     \li EvalError
74     \li RangeError
75     \li ReferenceError
76     \li SyntaxError
77     \li TypeError
78     \li URIError
79     \endlist
80
81     \section2 Other Properties
82
83     \list
84     \li Math
85     \li JSON
86     \endlist
87
88     \section1 The Object Object
89
90     \section2 Object Constructor
91
92     \section3 Function Properties
93
94     \list
95     \li getPrototypeOf(O)
96     \li getOwnPropertyDescriptor(O, P)
97     \li getOwnPropertyNames(O)
98     \li create(O [, Properties])
99     \li defineProperty(O, P, Attributes)
100     \li defineProperties(O, Properties)
101     \li keys(O)
102     \li seal(O)
103     \li isSealed(O)
104     \li freeze(O)
105     \li isFrozen(O)
106     \li preventExtensions(O)
107     \li isExtensible(O)
108     \endlist
109
110     \section2 Object Prototype
111
112     \section3 Function Properties
113
114     \list
115     \li toString()
116     \li toLocaleString()
117     \li valueOf()
118     \li hasOwnProperty(V)
119     \li isPrototypeOf(V)
120     \li propertyIsEnumerable(V)
121     \endlist
122
123     \section1 Function Objects
124
125     \section2 Function Prototype
126
127     \section3 Function Properties
128
129     \list
130     \li toString()
131     \li apply(thisArg, argArray)
132     \li call(thisArg [, arg1 [, arg2, ...]])
133     \li bind((thisArg [, arg1 [, arg2, …]])
134     \endlist
135
136     \section1 Array Objects
137
138     \section2 Array Prototype Object
139
140     \section3 Function Properties
141
142     \list
143     \li toString()
144     \li toLocaleString()
145     \li concat([item1 [, item2 [, ...]]])
146     \li join(separator)
147     \li pop()
148     \li push([item1 [, item2 [, ...]]])
149     \li reverse()
150     \li shift()
151     \li slice(start, end)
152     \li sort(comparefn)
153     \li splice(start, deleteCount[, item1 [, item2 [, ...]]])
154     \li unshift([item1 [, item2 [, ...]]])
155     \li indexOf(searchElement [, fromIndex])
156     \li lastIndexOf(searchElement [, fromIndex])
157     \li every(callbackfn [, thisArg])
158     \li some(callbackfn [, thisArg])
159     \li forEach(callbackfn [, thisArg])
160     \li map(callbackfn [, thisArg])
161     \li filter(callbackfn [, thisArg])
162     \li reduce(callbackfn [, initialValue])
163     \li reduceRight(callbackfn [, initialValue])
164     \endlist
165
166     \section1 String Objects
167
168     \section2 String Prototype Object
169
170     \section3 Function Properties
171
172     \list
173     \li toString()
174     \li valueOf()
175     \li charAt(pos)
176     \li charCodeAt(pos)
177     \li concat([string1 [, string2 [, ...]]])
178     \li indexOf(searchString ,position)
179     \li lastIndexOf(searchString, position)
180     \li localeCompare(that)
181     \li match(regexp)
182     \li replace(searchValue, replaceValue)
183     \li search(regexp)
184     \li slice(start, end)
185     \li split(separator, limit)
186     \li substring(start, end)
187     \li toLowerCase()
188     \li toLocaleLowerCase()
189     \li toUpperCase()
190     \li toLocaleUpperCase()
191     \li trim()
192     \endlist
193
194     \section1 Boolean Objects
195
196     \section2 Boolean Prototype Object
197
198     \section3 Function Properties
199
200     \list
201     \li toString()
202     \li valueOf()
203     \endlist
204
205     \section1 Number Objects
206
207     \section2 Number Prototype Object
208
209     \section3 Function Properties
210
211     \list
212     \li toString(radix)
213     \li toLocaleString()
214     \li toFixed(fractionDigits)
215     \li toExponential(fractionDigits)
216     \li toPrecision(precision)
217     \endlist
218
219     \section1 The Math Object
220
221     \section2 Value Properties
222
223     \list
224     \li E
225     \li LN10
226     \li LN2
227     \li LOG2E
228     \li LOG10E
229     \li PI
230     \li SQRT1_2
231     \li SQRT2
232     \endlist
233
234     \section2 Function Properties
235
236     \list
237     \li abs(x)
238     \li acos(x)
239     \li asin(x)
240     \li atan(x)
241     \li atan2(y, x)
242     \li ceil(x)
243     \li cos(x)
244     \li exp(x)
245     \li floor(x)
246     \li log(x)
247     \li max([value1 [, value2 [, ...]]])
248     \li min([value1 [, value2 [, ...]]])
249     \li pow(x, y)
250     \li random()
251     \li round(x)
252     \li sin(x)
253     \li sqrt(x)
254     \li tan(x)
255     \endlist
256
257     \section1 Date Objects
258
259     \section2 Date Prototype Object
260
261     \section3 Function Properties
262
263     \list
264     \li toString()
265     \li toDateString()
266     \li toTimeString()
267     \li toLocaleString()
268     \li toLocaleDateString()
269     \li toLocaleTimeString()
270     \li valueOf()
271     \li getTime()
272     \li getFullYear()
273     \li getUTCFullYear()
274     \li getMonth()
275     \li getUTCMonth()
276     \li getDate()
277     \li getUTCDate()
278     \li getDay()
279     \li getUTCDay()
280     \li getHours()
281     \li getUTCHours()
282     \li getMinutes()
283     \li getUTCMinutes()
284     \li getSeconds()
285     \li getUTCSeconds()
286     \li getMilliseconds()
287     \li getUTCMilliseconds()
288     \li getTimeZoneOffset()
289     \li setTime(time)
290     \li setMilliseconds(ms)
291     \li setUTCMilliseconds(ms)
292     \li setSeconds(sec [, ms])
293     \li setUTCSeconds(sec [, ms])
294     \li setMinutes(min [, sec [, ms]])
295     \li setUTCMinutes(min [, sec [, ms]])
296     \li setHours(hour [, min [, sec [, ms]]])
297     \li setUTCHours(hour [, min [, sec [, ms]]])
298     \li setDate(date)
299     \li setUTCDate(date)
300     \li setMonth(month [, date])
301     \li setUTCMonth(month [, date])
302     \li setFullYear(year [, month [, date]])
303     \li setUTCFullYear(year [, month [, date]])
304     \li toUTCString()
305     \li toISOString()
306     \li toJSON()
307     \endlist
308
309     \section1 RegExp Objects
310
311     \section2 RegExp Prototype Object
312
313     \section3 Function Properties
314
315     \list
316     \li exec(string)
317     \li test(string)
318     \li toString()
319     \endlist
320
321     \section1 Error Objects
322
323     \section2 Error Prototype Object
324
325     \section3 Value Properties
326
327     \list
328     \li name
329     \li message
330     \endlist
331
332     \section3 Function Properties
333
334     \list
335     \li toString()
336     \endlist
337
338     \section1 The JSON Object
339
340     \section2 Function Properties
341
342     \list
343     \li parse(text [, reviver])
344     \li stringify(value [, replacer [, space]])
345     \endlist
346
347 */