aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix broken linksSze Howe Koh2013-12-3010-18/+21
| | | | | Change-Id: I4c4577edde96978a986606bf30fbb925f871bd42 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Update examples used in Writing QML Extensions tutorialTopi Reinio2013-11-301-16/+29
| | | | | | | | | | | | | | | | | | | Update the examples to use Qt's resource file system to store the qml files in, enabling them to run unmodified in any platform/build configuration. Also, - Chapter 6: Move the plugin code to a subproject and create a C++ application to use the plugin - Update documentation related to above chapter - Add thumbnails for the examples so they will appear in Qt Creators example list. Task-number: QTBUG-35001 Change-Id: I29122af11bb11c7e5e17993438e5fc18c7f96f89 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Kai Koehne <kai.koehne@digia.com>
* Add a new variant of qmlRegisterSingletonType for QML singletons.Antti Piira2013-11-091-1/+50
| | | | | | | | | | | | | | Adds a new public API to register a QML based singleton type from C++. This is the equivalent of the the qmlRegisterType, but for singletons. qmldir file is not needed for types registered through this function, but the type still needs to include the following pragma statement among the import statements: pragma Singleton Change-Id: Icb35b665fe2a8605667fe8ac575347be2a60490c Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Remove time type documentationAlan Alpert2013-11-051-30/+0
| | | | | | | | | | | While the time type does technically exist, it cannot be created from QML. Pending a discussion about its future, the doc will be temporarily removed to avoid confusing people. Task-number: QTBUG-32295 Change-Id: Ic171a7f4a5d7c0515427a6d1d65bed0abcfe3643 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Doc: Fix broken linksSze Howe Koh2013-11-058-11/+11
| | | | | | Change-Id: Ie7408409ddbaa354370267f2dd74326ec56a4186 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Fix typosSze Howe Koh2013-11-051-1/+1
| | | | | | Task-number: QTBUG-33360 Change-Id: I913c14d3d6a90d2c20e40e246ad11f50a26c3ad9 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fix QUrl conversion detailsSze Howe Koh2013-11-051-1/+1
| | | | | | | Task-number: QTBUG-33360 Change-Id: I2f6889d798c6c10f1412f5adb69dd0362ac790fb Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Revert commit d818575966e2e2000fe2b7ee390c620f595d9825Simon Hausmann2013-10-211-9/+0
| | | | | | | | | | | | This reverts the commit that deprecated the with statement and added a note to the docs that binding expressions will be compiled in strict mode in Qt 5.2. It turns out that we had to keep the with statement and enabling strict mode breaks just too much unfortunately. Change-Id: Id38c27f684fbfcb6b6b848be8f691658089d1adb Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Renamed links to "QML Applications".Jerome Pasion2013-10-151-3/+3
| | | | | | | | | | | "QML Application Developer Resources" is too long and the visible text is usually shortened to "QML Applications". The article in qt5/qtdoc changed title to "QML Applications". Change-Id: I301f3b4659bd87631269b912bcc36f6f00fdeb2c Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: no longer recognizes the version nr in QML refsMartin Smith2013-10-029-33/+33
| | | | | | | | | | All QML references of the form <QML-module-name><QML-module-version>::<QML-type>::<member-name> have had the <QML-module-version> removed i. Task-number: QTBUG-33776 Change-Id: Idde279e0f254cd24ea44f9841662dd81a2c5bbc6 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Updated imports, \qmlmodule, and \inqmlmodule versions in src/qml.Jerome Pasion2013-09-274-7/+7
| | | | | | | | | | | | -QDoc ignores the version in \inqmlmodule so its better to remove them to avoid confusion. -Qt QML import version is 2.2 for 5.2 release -Qt Quick import version is 2.2 for 5.2 release Task-number: QTBUG-32172 Change-Id: I15df270f1fb4df0476a9ddd854fb9ddf58e9fc7c Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Import QtQml instead of QtQuick now that Locale is available there.Mitch Curtis2013-09-251-1/+1
| | | | | | | 97feace2aaaf08075c17ea175a5ed0c12aa40a0d made it available. Change-Id: I4a263a26c1db164f410c49fe0fca776aed53f7e8 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fix documentation of qmlProtectModuleTopi Reinio2013-09-251-3/+5
| | | | | | | | Fix the function signature used in \fn command and document the parameters. Change-Id: Ieda9b2b402886b81691195dbad17663fd454f282 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Add qmlProtectModuleAlan Alpert2013-09-201-0/+25
| | | | | | | | | A C++ analog to the protected qmldir syntax, this is also a potential performance improvement because we can avoid some file system accesses. Change-Id: I41781a6cc72aa65bd2d397800345ea16ef442e90 Reviewed-by: Antti Piira <apiira@blackberry.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Merge branch 'stable' into devSergio Ahumada2013-09-193-14/+108
|\ | | | | | | | | | | | | | | Conflicts: src/qml/qml/v8/qqmlbuiltinfunctions.cpp tests/auto/qml/qml.pro Change-Id: Ib373aed6a8f8df9521740fb5b080daed38546cd2
| * Doc: Reintroduce docs for Qt Quick Models and Views examplesTopi Reinio2013-09-181-5/+9
| | | | | | | | | | | | | | | | | | The .qdoc files/images for these examples were lost during modularization. This change adds them back and fixes related links. Change-Id: Id5260daad1c38284e3aa8178ae82d24067f4e88c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Improve QML Date object documentation.Mitch Curtis2013-09-171-7/+97
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Carrying on from https://codereview.qt-project.org/#change,61255, I've added documentation for the from*String() functions, as they weren't actually documented. I've also formatted some arguments and linked to Locale documentation where the format enums are mentioned. Note that, because of QTBUG-32505, I can't link to the format enum directly, so I just link to the Locale page itself. The import QtQuick 2.0 should also be removed from the documentation when that bug is fixed. Task-number: QTBUG-32492 Change-Id: I19c6c8450746ef2a68bc55fd3ef7db776f4acc35 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Doc: Move properties of Locale QML type to correct moduleTopi Reinio2013-09-172-2/+2
| | | | | | | | | | | | | | | | | | Moves property and method documentation for QML Locale type from Qt Quick to Qt Qml module, and fix a number of broken links in locale-related docs. Change-Id: Id9e01314ea867987f5159ca3bffcc40abb27b289 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* | Merge "Merge branch 'stable' into dev" into refs/staging/devSergio Ahumada2013-08-065-9/+15
|\|
| * Doc: Link to QML Qt object in relevant locationsTopi Reinio2013-07-252-1/+6
| | | | | | | | | | | | | | | | | | | | There is no obvious path to find the reference for QML Qt object. This change adds links to it in Qt QML module index page and QML Basic Types documentation. Task-number: QTBUG-31921 Change-Id: I8a4ef1b3e696a0a7dec416d759ae64110e59c6c0 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Link between "QML Basic Type: date" and QML Date object documentation.Mitch Curtis2013-07-233-8/+9
| | | | | | | | | | | | | | | | | | | | The basic date type seems useless if you don't know it can be used as as JavaScript date (with QML extensions). Task-number: QTBUG-32492 Change-Id: I14962f4e57522f5515f0e78d484aa59fcd9dff3c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Doc: Updated Qt QML and Qt Quick module pages.Jerome Pasion2013-08-051-0/+2
|/ | | | | | | | -added \qtvariable -added Qt QML to the modules group Change-Id: I524bbcea501b7ab5ea49482de0119e3e6d630065 Reviewed-by: Martin Smith <martin.smith@digia.com>
* QtQml: document QQmlExtensionPlugin::baseUrlShawn Rutledge2013-06-281-0/+2
| | | | | | | | | | | It was added here https://codereview.qt-project.org/#change,47532 without documentation. Also updated \since because for now qdoc seems to interpret \since 5.0 as QtQml 5.0. Task-number: QTBUG-31928 Change-Id: I652e9471f1ad8e83b355bffc8498a6565dc9aa2b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Update 5.1.0 changelog and what's newAlan Alpert2013-06-251-0/+5
| | | | | | | All the new features should now be listed in those two documents Change-Id: Ifa17581bf589f3a18b602f8a1d10683a5e48c70d Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
* Doc: Clarified members of QtQml.Models submodule.Jerome Pasion2013-06-043-6/+25
| | | | | | | | | | | | | | -Took out members of QtQml.Models submodule from Qt QML and Qt Quick. -Set up qdocconf files to include QtQml.Models to be part of Qt QML doc build. -Edited the sentences to make it clearer that list and model types are in QtQml.Models. -Placed the Visual* types back to QtQuick 2 module. -This patch removes several collision pages. Change-Id: I16e7045162af6852e5d6c3162b6f4cf97a42402b Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Deprecate the with statement in QMLSimon Hausmann2013-05-311-0/+9
| | | | | | | | | | | | | It is generally considered deprecated in JavaScript and its use disables a whole range of optimizations that we would like to apply in the future. Therefore this patch will issue a warning if the with statement is detected. This change is also documented, along with the plan on enabling strict mode in the future. Change-Id: Ie60f0536e0bdd6ecc537d8e34efbd8868bcad743 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Added Qt 5.1 details in Qt QML's release notes.Jerome Pasion2013-05-301-1/+22
| | | | | Change-Id: Ie5a4199563b22c21d7be009aeb85206670b84642 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix some broken linksSze Howe Koh2013-05-202-2/+2
| | | | | Change-Id: I1385a8947107a7c80b32306fc587aff45536a4ec Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Update references to QDeclarative* classesSze Howe Koh2013-05-151-1/+1
| | | | | Change-Id: Ifbde8c1ccfc0c759da6f2204320b9170a04179eb Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Removed pages from the "qml-features" group.Jerome Pasion2013-05-151-2/+0
| | | | | | | | | -This group is from Qt 4 and no longer relevant in Qt 5. -The \group page in qtdoc is removed. Change-Id: I6349a9056ae45c98b31c70fd693adecf71e2ba8c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: Fixed a bunch of missing snippets.Jerome Pasion2013-05-151-4/+4
| | | | | | | | -moved delegate model related snippets from Qt Quick to Qt QML. -corrected snippet paths Change-Id: If688f97fb9317def16f343d5502a6a54d6761e95 Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: Define Qt global object as a QML type and fix referring docsTopi Reinio2013-05-157-20/+20
| | | | | | | | | | | This change adds the Qt global object as a QML type in the Qt QML module and fixes links to it in documentation. Task-number: QTBUG-29353 Change-Id: I1690224091a79a3309fac7a78aa0c0c734449e4f Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* 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: Fix some broken snippet pathsSze Howe Koh2013-05-061-2/+2
| | | | | Change-Id: Ib79bfbea402b86e26a503de47383522317ca906b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Move example docs related to QtQml under the correct moduleTopi Reinio2013-05-031-48/+48
| | | | | | | | | | | This change moves 'Extending QML' qdoc file and the tutorials from examples/quick to examples/qml, which is the correct location for them. Change-Id: I24bd9dfa75baaab7bc8efe08489f09a7b65d98a6 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Elaborate on versioning docsAlan Alpert2013-05-011-0/+5
| | | | | | Task-number: QTBUG-30808 Change-Id: I1930bd91a6c2089047ac7e7d74da2c977c522e07 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Changed order of pages in QML reference.Jerome Pasion2013-04-301-9/+10
| | | | | | | | | | | | | New order: QML Syntax Basics QML Object Attributes Property Binding Signal and Handler Event System Integrating QML and JavaScript [etc.] Change-Id: I19e6fc10e36963362dd862feeb697f942902aaac Reviewed-by: Bea Lam <bea.lam@jollamobile.com>
* Doc: Replace some references to NokiaSze Howe Koh2013-04-241-1/+1
| | | | | | | Link to internal QDoc pages, or to qt-project.org Change-Id: I5d9adae711213873ab57ccfc5bb2d8f74cf5689b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Un-overload the word "module"Sze Howe Koh2013-04-246-8/+9
| | | | | | | | | | | "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: Create links to Qt Quick 1Sze Howe Koh2013-04-241-1/+1
| | | | | | | | | | | Point to the porting guide, so that users who search for the old names will be directed to an explanation of the name change. Also made some new links to Qt Quick 2, and changed "favour" -> "favor" (Sanity Bot complained) Change-Id: If30c8d619d8fdb9df72b7b5f3efd356f1e07b23a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Qt Quick: Fix module name format (Pt 2/2)Sze Howe Koh2013-04-232-3/+3
| | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation Attempt to differentiate between the whole module ("Qt Quick") and the QML import ("QtQuick") by encoding the latter with monospace font. There are places in the text where both representations are valid. Change-Id: If398304757e0a5106542c09099e1814084e54c5c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Qt Quick: Fix module name format (Pt 1/2)Sze Howe Koh2013-04-2311-25/+25
| | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation Attempt to differentiate between the whole module ("Qt Quick") and the QML import ("QtQuick") by encoding the latter with monospace font. There are places in the text where both representations are valid. Change-Id: Id6e157a4191aaa4e23a9cd5c76abfe902fe43d33 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Reinstating \qmlmodule page.Jerome Pasion2013-04-231-0/+53
| | | | | | | Was removed in an earlier commit. Change-Id: I1fdaf6c7e1e522f6ba7e36a20040b8222b1714cc Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Refactored and focused the Qt QML documentation.Jerome Pasion2013-04-2323-263/+201
| | | | | | | | | | | | | | | | | Before it wasn't clear to what the module provided, especially with the coupling of Qt QML and Qt Quick. The doc is centered around these documentation: -QML refernce: the language syntax and the application constructs -JavaScript environment: the environment provided by the module -Integration with C++: more about the engine and the C++ API -QML Types and Classes reference (created by \qmlmodule and \module) The distinction are made in the directory and the section titles in the Qt QML landing page. Change-Id: I033bfcbf8368b94ffa5ee4b1225bee74347f53eb Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Qt QML: Fix module name formatSze Howe Koh2013-04-194-10/+10
| | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtQml -> Qt QML Change-Id: I45ca4496a02214feab48707b026c6bec085df138 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Reassigned types and pages to their correct modules.Jerome Pasion2013-04-174-7/+3
| | | | | | | | | | | | 1)Moved classes and basic types to \module QtQml 2. -QQml* classes are in QtQml 2 for 5.1 2)Removed \inqmlmodule commands in overviews and tutorials. -Only QML API should have \inqmlmodule commands because they are added to the auto generated list of types. Change-Id: I9aa3ca8062fa9fed76734885829879122841b119 Reviewed-by: Alan Alpert <aalpert@blackberry.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>
* Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-04-031-6/+6
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: examples/qml/xmlhttprequest/doc/src/xmlhttprequest.qdoc examples/quick/accessibility/doc/src/accessibility.qdoc examples/quick/animation/doc/src/animation.qdoc examples/quick/canvas/doc/src/canvas.qdoc examples/quick/draganddrop/doc/src/draganddrop.qdoc examples/quick/imageelements/doc/src/imageelements.qdoc examples/quick/keyinteraction/doc/src/keyinteraction.qdoc examples/quick/localstorage/doc/src/localstorage.qdoc examples/quick/mousearea/doc/src/mousearea.qdoc examples/quick/particles/affectors/doc/src/affectors.qdoc examples/quick/particles/customparticle/doc/src/customparticle.qdoc examples/quick/particles/emitters/doc/src/emitters.qdoc examples/quick/particles/imageparticle/doc/src/imageparticle.qdoc examples/quick/particles/system/doc/src/system.qdoc examples/quick/positioners/doc/src/positioners.qdoc examples/quick/righttoleft/doc/src/righttoleft.qdoc examples/quick/scenegraph/customgeometry/doc/src/customgeometry.qdoc examples/quick/scenegraph/openglunderqml/doc/src/openglunderqml.qdoc examples/quick/scenegraph/simplematerial/doc/src/simplematerial.qdoc examples/quick/threading/doc/src/threading.qdoc examples/quick/touchinteraction/doc/src/touchinteraction.qdoc examples/quick/views/doc/src/views.qdoc Change-Id: Idf7bb76c82acacf86b19a9f4633c3cbf4ae1a9a0
| * Fix duplicate examples for qml/quick modulesKai Koehne2013-03-211-6/+6
| | | | | | | | | | | | Task-number: QTBUG-30233 Change-Id: Ic0a6d9112dbf8903d68f571e0ac853d89ff31ebe Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Doc: Fix some titles and linksSze Howe Koh2013-03-304-9/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Make page titles follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation. Make class/type list titles follow the "<Qt Module> C++ Classes" and "<Qt Module> QML Types" formats. Links are updated accordingly, along with broken links found during this sweep. Some inline links also have their surrounding text modified, to improve flow. Change-Id: I0ed7788caa250085d7ea0080a77d8a2655debf39 Reviewed-by: Alan Alpert <aalpert@blackberry.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-19 12:29:43 +0000