diff options
Diffstat (limited to 'doc/src')
20 files changed, 110 insertions, 11 deletions
diff --git a/doc/src/images/gridview-layout-lefttoright-ltr-btt.png b/doc/src/images/gridview-layout-lefttoright-ltr-btt.png Binary files differnew file mode 100644 index 0000000000..4439f8370a --- /dev/null +++ b/doc/src/images/gridview-layout-lefttoright-ltr-btt.png diff --git a/doc/src/images/gridview-layout-lefttoright-ltr-ttb.png b/doc/src/images/gridview-layout-lefttoright-ltr-ttb.png Binary files differnew file mode 100644 index 0000000000..af745b7d1e --- /dev/null +++ b/doc/src/images/gridview-layout-lefttoright-ltr-ttb.png diff --git a/doc/src/images/gridview-layout-lefttoright-rtl-btt.png b/doc/src/images/gridview-layout-lefttoright-rtl-btt.png Binary files differnew file mode 100644 index 0000000000..bc7e568972 --- /dev/null +++ b/doc/src/images/gridview-layout-lefttoright-rtl-btt.png diff --git a/doc/src/images/gridview-layout-lefttoright-rtl-ttb.png b/doc/src/images/gridview-layout-lefttoright-rtl-ttb.png Binary files differnew file mode 100644 index 0000000000..3ebf74fae5 --- /dev/null +++ b/doc/src/images/gridview-layout-lefttoright-rtl-ttb.png diff --git a/doc/src/images/gridview-layout-toptobottom-ltr-btt.png b/doc/src/images/gridview-layout-toptobottom-ltr-btt.png Binary files differnew file mode 100644 index 0000000000..b60ab4b5e7 --- /dev/null +++ b/doc/src/images/gridview-layout-toptobottom-ltr-btt.png diff --git a/doc/src/images/gridview-layout-toptobottom-ltr-ttb.png b/doc/src/images/gridview-layout-toptobottom-ltr-ttb.png Binary files differnew file mode 100644 index 0000000000..9078cbde6f --- /dev/null +++ b/doc/src/images/gridview-layout-toptobottom-ltr-ttb.png diff --git a/doc/src/images/gridview-layout-toptobottom-rtl-btt.png b/doc/src/images/gridview-layout-toptobottom-rtl-btt.png Binary files differnew file mode 100644 index 0000000000..0d0f095598 --- /dev/null +++ b/doc/src/images/gridview-layout-toptobottom-rtl-btt.png diff --git a/doc/src/images/gridview-layout-toptobottom-rtl-ttb.png b/doc/src/images/gridview-layout-toptobottom-rtl-ttb.png Binary files differnew file mode 100644 index 0000000000..c1c353a4da --- /dev/null +++ b/doc/src/images/gridview-layout-toptobottom-rtl-ttb.png diff --git a/doc/src/images/listview-layout-bottomtotop.png b/doc/src/images/listview-layout-bottomtotop.png Binary files differnew file mode 100644 index 0000000000..980f81d07f --- /dev/null +++ b/doc/src/images/listview-layout-bottomtotop.png diff --git a/doc/src/images/listview-layout-lefttoright.png b/doc/src/images/listview-layout-lefttoright.png Binary files differnew file mode 100644 index 0000000000..2ee0e4c4ff --- /dev/null +++ b/doc/src/images/listview-layout-lefttoright.png diff --git a/doc/src/images/listview-layout-righttoleft.png b/doc/src/images/listview-layout-righttoleft.png Binary files differnew file mode 100644 index 0000000000..2c54a2a7b1 --- /dev/null +++ b/doc/src/images/listview-layout-righttoleft.png diff --git a/doc/src/images/listview-layout-toptobottom.png b/doc/src/images/listview-layout-toptobottom.png Binary files differnew file mode 100644 index 0000000000..2054a5743b --- /dev/null +++ b/doc/src/images/listview-layout-toptobottom.png diff --git a/doc/src/external-resources.qdoc b/doc/src/qml/external-resources.qdoc index b4aecbad75..386992f439 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/qml/external-resources.qdoc @@ -28,5 +28,8 @@ /*! \externalpage http://www.ecma-international.org/publications/standards/Ecma-262.htm \title ECMA-262 + + \externalpage http://www.w3schools.com/jsref/default.asp + \title W3Schools JavaScript Reference */ diff --git a/doc/src/qml/hostenvironment.qdoc b/doc/src/qml/hostenvironment.qdoc new file mode 100644 index 0000000000..b0d9118944 --- /dev/null +++ b/doc/src/qml/hostenvironment.qdoc @@ -0,0 +1,92 @@ +/**************************************************************************** +** +** 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 qmlhostenvironment.html +\title QML JavaScript Host Environment + +QML provides a JavaScript host environment tailored to writing QML applications. +This environment is different from the host environment provided by a browser +or a server-side JavaScript environment such as Node.js. For example, QML does +not provide a \c window object or \c{DOM API} as commonly found in a browser environment. + +\section1 Common Base + +Like a browser or server-side JavaScript environment, the QML runtime implements the +\l{ECMA-262}{ECMAScript Language Specification} standard. This provides access to +all of the built-in types and functions defined by the standard, such as Object, Array, and Math. +The QML runtime implements the 5th edition of the standard, which is the same edition commonly +implemented by browsers. + +The standard ECMAScript built-ins are not explicitly documented in the QML documentation. For more +information on their use, please refer to the ECMA-262 5th edition standard or one of the many online +JavaScript reference and tutorial sites, such as the \l{W3Schools JavaScript Reference} (JavaScript Objects +Reference section). Many sites focus on JavaScript in the browser, so in some cases you may need to double +check the specification to determine whether a given function or object is part of standard ECMAScript or +specific to the browser environment. In the case of the W3Schools link above, the \c{JavaScript Objects +Reference} section generally covers the standard, while the \c{Browser Objects Reference} and \c{HTML DOM +Objects Reference} sections are browser specific (and thus not applicable to QML). + +\section1 Host Objects and Functions + +The QML JavaScript host environment implements the following host objects and functions: + +\list +\li The \l{QmlGlobalQtObject}{Qt object}: This object is specific to QML, and provides helper methods + and properties specific to the QML environment. +\li qsTr(), qsTranslate(), qsTrId(), QT_TR_NOOP(), QT_TRANSLATE_NOOP(), and QT_TRID_NOOP() functions: + These functions are specific to QML, and provide \l{Translation}{translation capabilities} to the QML environment. +\li gc() function: This function is specific to QML, and provides a way to manually trigger garbage collection. +\li print() function: This function is specific to QML, and provides a simple way to output information to the console. +\li The \l{Console API}{console object}: This object implements a subset of the \l{http://getfirebug.com/wiki/index.php/Console_API}{FireBug Console API}. +\li \l{XMLHttpRequest}, DOMException: These objects implement a subset of the \l{http://www.w3.org/TR/XMLHttpRequest/}{W3C XMLHttpRequest specification}. +\endlist + +See \l{QML Global Object} for more details on these host objects and functions. + +\section1 Native Object Modification + +QML makes the following modifications to native objects: + +\list +\li An arg() function is added to the String prototype. +\li Locale-aware coversion functions are added to the \l{Date} and \l{Number} prototypes. +\endlist + +\section1 Restrictions + +QML implements the following restrictions for JavaScript code: + +\list +\li JavaScript code cannot modify the global object. +\li Global code is run in a reduced scope. +\li The value of \c this is undefined in QML in the majority of contexts. +\endlist + +See \l {QML JavaScript Restrictions} for more details on these restrictions. + +*/ diff --git a/doc/src/qml/qmlengine.qdoc b/doc/src/qml/qmlengine.qdoc index b0754fe3ab..ad77d43cb5 100644 --- a/doc/src/qml/qmlengine.qdoc +++ b/doc/src/qml/qmlengine.qdoc @@ -467,9 +467,13 @@ specified in QML files, plugins, or applications. \section1 JavaScript Runtime - The runtime implements the \l{ECMA-262}{ECMAScript Language Specification} standard. - The reserved words, conditionals, variables, and object behaviors follow - after the standard. + The runtime implements the \l{ECMA-262}{ECMAScript Language Specification} standard, + 5th edition. The reserved words, conditionals, variables, and object behaviors + follow after the standard. + + The \l{QML JavaScript Host Environment} article has information about the + JavaScript host environment provided by QML, which is different than the + browser host environment many are familiar with. The \l{JavaScript Code} article has information about placing JavaScript code within QML code. diff --git a/doc/src/qml/qmli18n.qdoc b/doc/src/qml/qmli18n.qdoc index d15beafb38..b65c001e8e 100644 --- a/doc/src/qml/qmli18n.qdoc +++ b/doc/src/qml/qmli18n.qdoc @@ -33,8 +33,8 @@ \section1 Translation -Strings in QML can be marked for translation using the qsTr(), qsTranslate(), -QT_TR_NOOP(), and QT_TRANSLATE_NOOP() functions. +Strings in QML can be marked for translation using the qsTr(), qsTranslate(), qsTrId(), +QT_TR_NOOP(), QT_TRANSLATE_NOOP(), and QT_TRID_NOOP() functions. For example: \qml diff --git a/doc/src/qml/qtdeclarative.qdoc b/doc/src/qml/qtqml.qdoc index 5ad637ab50..7bd797e8d0 100644 --- a/doc/src/qml/qtdeclarative.qdoc +++ b/doc/src/qml/qtqml.qdoc @@ -27,10 +27,10 @@ /*! \module QtQml - \title Qt Qml Module + \title Qt QML Module \ingroup modules - \brief The Qt Qml module provides a declarative framework + \brief The Qt QML module provides a declarative framework for building highly dynamic, custom user interfaces. To include the definitions of the module's classes, use the @@ -47,8 +47,8 @@ QT += qml \endcode - For more information on the Qt Qml module (including the visual - elements which are implemented on top of the Qt Qml module) see the + For more information on the Qt QML module (including the visual + elements which are implemented on top of the Qt QML module) see the \l{Qt Quick} documentation. */ @@ -68,7 +68,7 @@ Declares additional properties of the given \a Type as described by the specified \a Flags. - + Current the only supported type info is \c QML_HAS_ATTACHED_PROPERTIES which declares that the \a Type supports \l {Attached Properties}. @@ -113,7 +113,7 @@ qmlRegisterType<MySliderItem>("com.mycompany.qmlcomponents", 1, 0, "Slider"); \endcode - Once this is registered, the type can be used in QML by importing the + Once this is registered, the type can be used in QML by importing the specified module name and version number: \qml diff --git a/doc/src/qtdeclarative.qdoc b/doc/src/qtquick2/qtdeclarative.qdoc index d9b9234c90..d9b9234c90 100644 --- a/doc/src/qtdeclarative.qdoc +++ b/doc/src/qtquick2/qtdeclarative.qdoc diff --git a/doc/src/quick/qtquick.qdoc b/doc/src/qtquick2/qtquick.qdoc index c38ef3c801..c38ef3c801 100644 --- a/doc/src/quick/qtquick.qdoc +++ b/doc/src/qtquick2/qtquick.qdoc diff --git a/doc/src/whatsnew.qdoc b/doc/src/qtquick2/whatsnew.qdoc index 1997a42a6b..1997a42a6b 100644 --- a/doc/src/whatsnew.qdoc +++ b/doc/src/qtquick2/whatsnew.qdoc |
