aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/qmlfunctions.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Add qmlClearRegisteredTypes FunctionAlan Alpert2013-05-071-0/+14
| | | | | | | | | | | Registered types are stored in a global static variable, not on an engine instance. For applications managing multiple engines over their lifetime, there needs to be a way to clear the existing types so they can register new ones and avoid memory leaks. Task-Number: QTBUG-28572 Change-Id: Ic70a4dd1e29d99399b21fb42eaf10d4a52bf2adf Reviewed-by: Christopher Adams <chris.adams@jollamobile.com>
* Doc: Un-overload the word "module"Sze Howe Koh2013-04-241-1/+1
| | | | | | | | | | | "The Qt Quick module contains the QtQuick QML module and the Qt Quick C++ module" is an odd way to describe things. The concept of a "QML module" is deeply entrenched so this patch won't touch it, but at least we can get rid of references to "C++ module"s. Change-Id: Ib06f8e3152551901dc6016cb37507cb9608d7863 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add required include statement for qmlRegisterSingletonType docsTopi Reinio2013-04-161-5/+7
| | | | | | | | | Adds a missing include for QtQml into QQmlEngine class reference code snippets. Task-number: QTBUG-30642 Change-Id: I2ec10de5b31b4854d5aaea08987b9d75926d2ef4 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed some uses of terminolgies in qdoc files.Jerome Pasion2013-03-261-1/+1
| | | | | | | | | | | -"element" -> "type" or "object" (not in all cases where this change applies) -some instances of QtQuick. It should be "Qt Quick". -only in qdoc files. Examples and source code changes will be done later. Task-number: QTBUG-30180 Change-Id: Ie587461a138e97606f761ad1e90909c91b479303 Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Add qmlRegisterType for Composite TypesAlan Alpert2013-02-181-0/+17
| | | | | | | | | This is equivalent functionality to registering a composite type in a qmldir file, a type name in a versioned module is associated with a given file. This function now allows that to be done easily from C++. Change-Id: I1cf44b92c3ad7fee593f4f84773c35b56253e628 Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-101-1/+1
| | | | | | Change-Id: I6c3bd7bebe3d62d1cfd0fa6334544c9db8398c76 Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-231-14/+14
| | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: Ie7f5d49ed8235d7a7845ab68f99ad1c220e64d5c Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Update imports and module documentationChris Adams2012-08-081-7/+7
| | | | | | | | | | | | | | | | | | Recently, the qmldir syntax was modified to allow a module identifier directive to be specified. This allows us to guarantee that types provided in that namespace are not overridden by other modules. Given this fundamental change, the documentation needed to be updated to reflect the new terminology surrounding imports: - modules - identified vs legacy - directories - local and remote directory imports - JavaScript resources - scripts which can be imported directly Change-Id: I5a3d38de93d0186e79b87f2b3050f2b802088348 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Add type name to singleton (module api) implementations.Glenn Watson2012-08-081-46/+46
| | | | | | | | | | | | | This change renames the previous module api implementation to singleton types. When a singleton type is registered, a type name must be provided that is used when accessing the API from QML. This makes the implementation more consistent with the rest of QML. Task-number: QTBUG-26549 Change-Id: Iab0bb1ccf516bd3ae20aee562a64d22976e0aecd Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Fix various broken links in documentationBea Lam2012-08-031-2/+2
| | | | | Change-Id: I9e2dac37d18e3ca62e4a92be25e5c2e60ffeba00 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Document qmlAttachedPropertiesObject()Bea Lam2012-08-011-0/+23
| | | | | | | | This is discussed in the documentation on writing QML extensions from C++ but is not actually documented in the list of qml* functions. Change-Id: Id24be88dc3fa6d54cc5ee29e3da1686ea2732b39 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Document lack of qmlContext/qmlEngine in module API classesMatthew Vogt2012-07-161-0/+25
| | | | | | | Task-number: QTBUG-23116 Change-Id: Ia6620b4046ac3e72c8b304633fcad40cf0efe2ed Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Fix qmlRegisterModuleApi function linkageChris Adams2012-07-041-1/+1
| | | | | | | | The qdoc tag for the \fn doc was incorrect, leading to linkage errors. Task-number: QTBUG-26236 Change-Id: Ifd407915d9a1461bb2b48a6bf54bb085425ba76b Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Create new documentation structureChris Adams2012-06-211-0/+334
The documentation currently has no clear separation between Qt QML and Qt Quick. With recent commits like: 6c8378eaf1edbbefe6aaa3672b0127816a004fd7 and ab1e510121c8a679fdaca12ccd30e0f7ac12a26b the separation between the language definition and implementation, provided by Qt QML, and the standard library for the QML language, provided by Qt Quick, is clear. This commit creates a new documentation structure that is more navigable and separates concepts into logical categories, with clear separation between QtQML and QtQuick. It also provides a more generic QML Application Developer Resources page which contains links to information for QML application developers. Change-Id: Ia807ccfbfd24ffa0e1c7f0a51ed9d2ed3aa6a733 Reviewed-by: Martin Jones <martin.jones@nokia.com>