aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/qmltypereference.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fixed a few broken links and snippetsVenu2013-12-231-2/+2
| | | | | | | | | | Couple of \snippet references in the ListModel docs were pointing to files outside the exampledirs boundary. Update those references to use the relative path. Change-Id: Ibf9d0fda9e5280345b08cb66a4fe0db9142a42a6 Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Add references to Animators from the QML Type ReferenceGunnar Sletta2013-10-291-0/+6
| | | | | | | Task-number: QTBUG-34221 Change-Id: Iaa1d7f4dd70d2d8150e8360545a33ac984e6bebd Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed broken linksVenu2013-10-241-12/+15
| | | | | | | | | | | | | | | | | There were many links (including the broken) on the Qt Quick index page and QML type reference page using the html file name to link to a page or a section within a page. Using html file reference in a link is not a good approach as qdoc does not give complete control to the author to define the html file name. This change updates all such links to use the page \title and \target names, which are considered to be better ways to link. Task-number:QTBUG-33360 Change-Id: Ibd1b1e3223a7e205bbdcf21b1b7f6e515749c5c9 Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Added a QML module page for Qt Quick TestVenu2013-10-231-1/+15
| | | | | | | | | | | | This should avoid the TestCase and SignalSpy types being listed in the All Classes page, which is meant for the C++ classes. Task-number: QTBUG-33316 Change-Id: I0f2f9e557df89f46f656a8820602fe5712c64073 Reviewed-by: Caroline Chao <caroline.chao@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: no longer recognizes the version nr in QML refsMartin Smith2013-10-021-7/+7
| | | | | | | | | | 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: Fixed and updated Qt Quick's \qmlmodule pageJerome Pasion2013-09-251-5/+5
| | | | | | | | | | | -incremented version to Qt Quick 2.2 (in \qmlmodule page) -import changed to QtQuick 2.2 -\inqmlmodule no longer needs the version. QDoc will ignore the version but it is better to remove it now to avoid confusion Task-number: QTBUG-32172 Change-Id: I40b52e59667014720be40a35b3a8fb9836825e31 Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
* Doc: Fixed link to Qt Quick Layouts and made links consistentJerome Pasion2013-06-061-7/+7
| | | | | | | -better to use the "QML Types" pages as the version is not specified. Change-Id: I5b150bc8ada25c619dbecb5d68e70854dd9c14d6 Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Clarified members of QtQml.Models submodule.Jerome Pasion2013-06-041-3/+16
| | | | | | | | | | | | | | -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>
* Doc: Fix links for ListModel and ListElement typesTopi Reinio2013-05-291-3/+3
| | | | | | | Link to documentation under QtQml module. Change-Id: Id65d237558c235dcdda8ab206eddef23c2886a29 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add Dialogs/Controls/Layouts in submodules sectionCaroline Chao2013-05-271-0/+6
| | | | | | Change-Id: Ide4afaa74d73ea09cf329de593283c269ecdacb3 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
* Doc: Define Qt global object as a QML type and fix referring docsTopi Reinio2013-05-151-7/+7
| | | | | | | | | | | 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>
* Doc: Qt Quick: Fix module name format (Pt 2/2)Sze Howe Koh2013-04-231-1/+1
| | | | | | | | | | | | 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-231-9/+9
| | | | | | | | | | | | 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: Fix some titles and linksSze Howe Koh2013-03-301-5/+5
| | | | | | | | | | | | | | | 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>
* Add \qmlmodule commands for QtQml and QtQuickAlan Alpert2013-02-061-0/+13
| | | | | Change-Id: I07a961bb2c5e39bfef134264e5f24974e1501361 Reviewed-by: Jerome Pasion <jerome.pasion@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>
* Fix doc links to submodelsPaul Olav Tvete2012-12-101-4/+4
| | | | | Change-Id: I2c65a77ca9c5fa1df1f0ff2ea67655e9ce1b0039 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Cleaned up \module and \qmlmodule page for Qt Quick and Qt QML.Jerome Pasion2012-10-171-1/+2
| | | | | | | | -Qt Quick: used a regular page instead of \qmlmodule -Cleaned up titles and membership Change-Id: I8ae24fec203ea675d213bd0df6105d0c2abd8164 Reviewed-by: Martin Smith <martin.smith@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>
* Qt Quick docs: Added link to the submodules' pages.Jerome Pasion2012-09-121-0/+15
| | | | | Change-Id: Ia5d8967e241e0697f2903f26899d878210dd5570 Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
* Fix doc linksBea Lam2012-08-241-1/+1
| | | | | Change-Id: Iafbcd39472f3e6f12169ae1a17b4a040dbb9a8a4 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Improve main QtQml and QtQuick doc pagesBea Lam2012-08-091-2/+4
| | | | | | | | | | | Make the content of the two pages more consistent with one another. Also improve the reference documentation sections and fix some links. Also the apireferences.qdoc page is not necessary. Change-Id: I01c5b3757c2ec03b1365e4c9c348e33e06f8315f Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Allow invokable functions of value-type classes to be calledChris Adams2012-08-091-6/+505
| | | | | | | | | | | | Previously, invokable functions of value-type classes were returned as properties. This commit fixes that bug by allowing such functions to be invoked normally. It also improves copy-value type handling. This commit also ensures that QMatrix4x4 value types are constructed with qreal values as this is the storage type used internally. Change-Id: Iab0fe4c522ed53d60154e8a8d46dda925fb9f4de Reviewed-by: Martin Jones <martin.jones@nokia.com>
* Add type name to singleton (module api) implementations.Glenn Watson2012-08-081-1/+1
| | | | | | | | | | | | | 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>
* Improve QML basic types documentationChris Adams2012-07-301-12/+285
| | | | | | | | | | | | | | | Basic types are provided either by the language (int, string, bool, real, double, date, url, var, variant) or by modules (value types). In 5.1 we would like modules to be able to provide more basic types, and thus a cleaner separation of the documentation makes sense. This patch also improves linking of the term QtQml so that a clear distinction is made between the QtQml QML module and the QtQml C++ Qt Module (the QtQml QML module links now point to the QtQml type reference page). Change-Id: Ibe3ad33e4616c5f29ea38dadc27e13938aedb9d7 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Fixup types pageAlan Alpert2012-07-231-35/+35
| | | | | | | | | | | | No longer double referencing items No longer referencing SpriteGoal (in .Particles module) No longer referencing FolderListModel (in labs module) Moved some types and categories around Fixed some heading capitalization General rewording of several parts Change-Id: Ie36eb0c17ce6602c6ae15bceedaebebeaeeeaaab Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Add documentation about property value modifiersChris Adams2012-07-191-23/+11
| | | | | | | | | | | Previously, property value modifiers were only documented in QtQuick, when really they are a QtQml module / QML language feature. This commit also improves the QtQuick documentation for convenience types, and rearranges some links and content for improved consistency. Change-Id: Ic4dbe0b8bb85bdfbb8ac2f336c13c2960f8d1842 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Minor doc fixesYann Bodson2012-07-181-4/+4
| | | | | | | Don't capitalize minor words in titles to be consistent with Qt doc. Change-Id: Ib39ec50d7f9730a5bbf2b574ade8270e9290ec90 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Create new documentation structureChris Adams2012-06-211-0/+250
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-08 09:50:18 +0000