Doc: Adding list of JavaScript functions in QML.
authorJerome Pasion <jerome.pasion@nokia.com>
Tue, 17 Apr 2012 08:20:33 +0000 (10:20 +0200)
committerQt by Nokia <qt-info@nokia.com>
Thu, 19 Apr 2012 13:56:52 +0000 (15:56 +0200)
-Added a link to the ECMA-262 standard

Change-Id: I0b3173f93bf947908bf9d39d207468d2b9f0cbd7
Reviewed-by: Kent Hansen <kent.hansen@nokia.com>
doc/src/external-pages.qdoc [new file with mode: 0644]
doc/src/qml/jsfunctionlist.qdoc [new file with mode: 0644]

diff --git a/doc/src/external-pages.qdoc b/doc/src/external-pages.qdoc
new file mode 100644 (file)
index 0000000..e4fb837
--- /dev/null
@@ -0,0 +1,31 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\externalpage http://www.ecma-international.org/publications/standards/Ecma-262.htm
+\title External: ECMA-262
+*/
diff --git a/doc/src/qml/jsfunctionlist.qdoc b/doc/src/qml/jsfunctionlist.qdoc
new file mode 100644 (file)
index 0000000..35abc0a
--- /dev/null
@@ -0,0 +1,347 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page jsfunctionlist.html
+    \title List of JavaScript Objects and Functions
+    \brief A list of objects, functions, and properties supported in QML.
+
+    This reference contains a list of objects, functions and
+    properties supported by the \l{The QML Engine}{QML engine}. For a detailed
+    description, see the \l{External: ECMA-262} specification.
+
+    \section1 The Global Object
+
+    \section2 Value Properties
+
+    \list
+    \li NaN
+    \li Infinity
+    \li undefined
+    \endlist
+
+    \section2 Function Properties
+
+    \list
+    \li eval(x)
+    \li parseInt(string, radix)
+    \li parseFloat(string)
+    \li isNaN(number)
+    \li isFinite(number)
+    \li decodeURI(encodedURI)
+    \li decodeURIComponent(encodedURIComponent)
+    \li encodeURI(uri)
+    \li encodeURIComponent(uriComponent)
+    \endlist
+
+    \section2 Constructor Properties
+
+    \list
+    \li Object
+    \li Function
+    \li Array
+    \li String
+    \li Boolean
+    \li Number
+    \li Date
+    \li RegExp
+    \li Error
+    \li EvalError
+    \li RangeError
+    \li ReferenceError
+    \li SyntaxError
+    \li TypeError
+    \li URIError
+    \endlist
+
+    \section2 Other Properties
+
+    \list
+    \li Math
+    \li JSON
+    \endlist
+
+    \section1 The Object Object
+
+    \section2 Object Constructor
+
+    \section3 Function Properties
+
+    \list
+    \li getPrototypeOf(O)
+    \li getOwnPropertyDescriptor(O, P)
+    \li getOwnPropertyNames(O)
+    \li create(O [, Properties])
+    \li defineProperty(O, P, Attributes)
+    \li defineProperties(O, Properties)
+    \li keys(O)
+    \li seal(O)
+    \li isSealed(O)
+    \li freeze(O)
+    \li isFrozen(O)
+    \li preventExtensions(O)
+    \li isExtensible(O)
+    \endlist
+
+    \section2 Object Prototype
+
+    \section3 Function Properties
+
+    \list
+    \li toString()
+    \li toLocaleString()
+    \li valueOf()
+    \li hasOwnProperty(V)
+    \li isPrototypeOf(V)
+    \li propertyIsEnumerable(V)
+    \endlist
+
+    \section1 Function Objects
+
+    \section2 Function Prototype
+
+    \section3 Function Properties
+
+    \list
+    \li toString()
+    \li apply(thisArg, argArray)
+    \li call(thisArg [, arg1 [, arg2, ...]])
+    \li bind((thisArg [, arg1 [, arg2, …]])
+    \endlist
+
+    \section1 Array Objects
+
+    \section2 Array Prototype Object
+
+    \section3 Function Properties
+
+    \list
+    \li toString()
+    \li toLocaleString()
+    \li concat([item1 [, item2 [, ...]]])
+    \li join(separator)
+    \li pop()
+    \li push([item1 [, item2 [, ...]]])
+    \li reverse()
+    \li shift()
+    \li slice(start, end)
+    \li sort(comparefn)
+    \li splice(start, deleteCount[, item1 [, item2 [, ...]]])
+    \li unshift([item1 [, item2 [, ...]]])
+    \li indexOf(searchElement [, fromIndex])
+    \li lastIndexOf(searchElement [, fromIndex])
+    \li every(callbackfn [, thisArg])
+    \li some(callbackfn [, thisArg])
+    \li forEach(callbackfn [, thisArg])
+    \li map(callbackfn [, thisArg])
+    \li filter(callbackfn [, thisArg])
+    \li reduce(callbackfn [, initialValue])
+    \li reduceRight(callbackfn [, initialValue])
+    \endlist
+
+    \section1 String Objects
+
+    \section2 String Prototype Object
+
+    \section3 Function Properties
+
+    \list
+    \li toString()
+    \li valueOf()
+    \li charAt(pos)
+    \li charCodeAt(pos)
+    \li concat([string1 [, string2 [, ...]]])
+    \li indexOf(searchString ,position)
+    \li lastIndexOf(searchString, position)
+    \li localeCompare(that)
+    \li match(regexp)
+    \li replace(searchValue, replaceValue)
+    \li search(regexp)
+    \li slice(start, end)
+    \li split(separator, limit)
+    \li substring(start, end)
+    \li toLowerCase()
+    \li toLocaleLowerCase()
+    \li toUpperCase()
+    \li toLocaleUpperCase()
+    \li trim()
+    \endlist
+
+    \section1 Boolean Objects
+
+    \section2 Boolean Prototype Object
+
+    \section3 Function Properties
+
+    \list
+    \li toString()
+    \li valueOf()
+    \endlist
+
+    \section1 Number Objects
+
+    \section2 Number Prototype Object
+
+    \section3 Function Properties
+
+    \list
+    \li toString(radix)
+    \li toLocaleString()
+    \li toFixed(fractionDigits)
+    \li toExponential(fractionDigits)
+    \li toPrecision(precision)
+    \endlist
+
+    \section1 The Math Object
+
+    \section2 Value Properties
+
+    \list
+    \li E
+    \li LN10
+    \li LN2
+    \li LOG2E
+    \li LOG10E
+    \li PI
+    \li SQRT1_2
+    \li SQRT2
+    \endlist
+
+    \section2 Function Properties
+
+    \list
+    \li abs(x)
+    \li acos(x)
+    \li asin(x)
+    \li atan(x)
+    \li atan2(y, x)
+    \li ceil(x)
+    \li cos(x)
+    \li exp(x)
+    \li floor(x)
+    \li log(x)
+    \li max([value1 [, value2 [, ...]]])
+    \li min([value1 [, value2 [, ...]]])
+    \li pow(x, y)
+    \li random()
+    \li round(x)
+    \li sin(x)
+    \li sqrt(x)
+    \li tan(x)
+    \endlist
+
+    \section1 Date Objects
+
+    \section2 Date Prototype Object
+
+    \section3 Function Properties
+
+    \list
+    \li toString()
+    \li toDateString()
+    \li toTimeString()
+    \li toLocaleString()
+    \li toLocaleDateString()
+    \li toLocaleTimeString()
+    \li valueOf()
+    \li getTime()
+    \li getFullYear()
+    \li getUTCFullYear()
+    \li getMonth()
+    \li getUTCMonth()
+    \li getDate()
+    \li getUTCDate()
+    \li getDay()
+    \li getUTCDay()
+    \li getHours()
+    \li getUTCHours()
+    \li getMinutes()
+    \li getUTCMinutes()
+    \li getSeconds()
+    \li getUTCSeconds()
+    \li getMilliseconds()
+    \li getUTCMilliseconds()
+    \li getTimeZoneOffset()
+    \li setTime(time)
+    \li setMilliseconds(ms)
+    \li setUTCMilliseconds(ms)
+    \li setSeconds(sec [, ms])
+    \li setUTCSeconds(sec [, ms])
+    \li setMinutes(min [, sec [, ms]])
+    \li setUTCMinutes(min [, sec [, ms]])
+    \li setHours(hour [, min [, sec [, ms]]])
+    \li setUTCHours(hour [, min [, sec [, ms]]])
+    \li setDate(date)
+    \li setUTCDate(date)
+    \li setMonth(month [, date])
+    \li setUTCMonth(month [, date])
+    \li setFullYear(year [, month [, date]])
+    \li setUTCFullYear(year [, month [, date]])
+    \li toUTCString()
+    \li toISOString()
+    \li toJSON()
+    \endlist
+
+    \section1 RegExp Objects
+
+    \section2 RegExp Prototype Object
+
+    \section3 Function Properties
+
+    \list
+    \li exec(string)
+    \li test(string)
+    \li toString()
+    \endlist
+
+    \section1 Error Objects
+
+    \section2 Error Prototype Object
+
+    \section3 Value Properties
+
+    \list
+    \li name
+    \li message
+    \endlist
+
+    \section3 Function Properties
+
+    \list
+    \li toString()
+    \endlist
+
+    \section1 The JSON Object
+
+    \section2 Function Properties
+
+    \list
+    \li parse(text [, reviver])
+    \li stringify(value [, replacer [, space]])
+    \endlist
+
+*/