aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Use settings from global qdocconf.Casper van Donderen2012-09-051-52/+4
| | | | | | | Depends on the integration of #34077 Change-Id: I188d7617c4805d00226d0fb8d5768a02d24c6933 Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
* Docs - add missing images and code, clean up sectionsBea Lam2012-08-285-16/+16
| | | | | | | | | | Includes the removal of concepts/modelviewsdata/localstorage.qdoc since that is a duplicate of the existing Local Storage module docs. Also removes classes from whatsnew.qdoc that are internal. Change-Id: I4170c1797bbec09bb67784b0b2ad67fd990365a8 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Document the current behavior of overridden propertiesMatthew Vogt2012-08-281-0/+50
| | | | | Change-Id: I0d9cf0285824e05b846ffeca2d26fe573f93ccf4 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Fix various doc errorsBea Lam2012-08-285-17/+26
| | | | | | | | Also restore the main module "reference documentation" links added in 0e0f46c01cf6a183996d36c31987ca4a46b50bd9 Change-Id: I421f5a17e2946a2569537d8ba8a021f219aaf75a Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Update usage of smooth and antialiasing.Michael Brasser2012-08-283-3/+3
| | | | | | Change-Id: Icc8b28bdd466389ed3f269f076f1bdb6e9abe3f2 Reviewed-by: Yunqiao Yin <charles.yin@nokia.com> Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Improve docs related to visual parent conceptBea Lam2012-08-282-1/+2
| | | | | Change-Id: I73cc63c8a55cf949b94a2fa502cb331fb8adbda3 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Clean up structure of JavaScript related docsBea Lam2012-08-287-116/+136
| | | | | | | | | | | | | | | | The global object and list of javascript functions should be linked to as subsections from the "JavaScript Host Environment" topic page, and all of the subsections should be visible from the module index page. Also move the "restrictions" docs to this topic page as it's more relevant to this section. Also includes some minor doc improvements. Task-number: QTBUG-26380 Change-Id: Iba6e4e510191bf5e4603d6cbb2826ad7bcdbd10c Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Move data ownership docs and improve docsBea Lam2012-08-282-45/+39
| | | | | | | Move data ownership docs to where they can be found more easily. Change-Id: Id5262cee9b082bc472e4b6ccea853c57e66489ac Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Move the Property Modifier Type documentationChris Adams2012-08-275-69/+89
| | | | | | | | | | | Property Modifier Types are just another sort of QML object type, and don't deserve explicit top-level documentation. This commit moves the docs into the object types documentation, and adds documentation to the syntax page about the "<PropertyModifierObject> on <propertyName>" syntax. Change-Id: Ia9b707739b562d2c8b75fa99b88795ba4d415cf7 Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Fix doc linksBea Lam2012-08-241-1/+1
| | | | | Change-Id: Iafbcd39472f3e6f12169ae1a17b4a040dbb9a8a4 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Doc: Tidied links, titles, and HTML pages.Jerome Pasion2012-08-233-24/+14
| | | | | | | | -used "Qt Quick" and "Qt QML" to refer to the module -qtquick-index.html and qtqml-index.html for the landing pages Change-Id: I1569949f7875ac6008a5b80a169e327f93f330ae Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Fix snippets to compile to ensure they are validBea Lam2012-08-2221-851/+20
| | | | | | | | | Also deletes snippets that are no longer used by docs. Task-number: QTBUG-26637 Change-Id: I63e129f3169ae78aeb7ac840b6f5b5925dbd06b4 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Improve main QtQml and QtQuick doc pagesBea Lam2012-08-091-49/+33
| | | | | | | | | | | 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>
* Fix default property docsBea Lam2012-08-091-8/+5
| | | | | | | Item's default property is data. Change-Id: I60577f4cfbe954ab3311703915f43fecf4ed9bf2 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Update imports and module documentationChris Adams2012-08-0817-641/+1175
| | | | | | | | | | | | | | | | | | 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-088-76/+75
| | | | | | | | | | | | | 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>
* Restore QML/C++ extensions tutorial and fix plugin docs and examplesBea Lam2012-08-074-27/+519
| | | | | | | | | | | | | | | | | This restores the "Writing QML Extensions with C++" tutorial that was removed during the recent QML doc restructure. This also updates outdated docs in "Creating C++ Plugins for QML" that referred to the use of Q_EXPORT_PLUGIN2() and such as the process for writing QML plugins in Qt 5 has changed. Note the plugins.json line was removed from examples/qml/cppextensions/plugins/plugins.pro since this json file was removed in a previous commit, as plugins no longer require the empty json file. Change-Id: I795d6faf6a741466a952feb8e15b028ec3d52b69 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Minor update for release notesBea Lam2012-08-071-0/+2
| | | | | Change-Id: Ia474f5136fd8e22aad948abf0c3e1ac44290aa41 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Add specifics of attached property syntaxBea Lam2012-08-031-0/+7
| | | | | Change-Id: Ia5f40e3d65ed8af2f9a14e3f44a1d41160ddf143 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Fix various broken links in documentationBea Lam2012-08-0320-56/+52
| | | | | Change-Id: I9e2dac37d18e3ca62e4a92be25e5c2e60ffeba00 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Use \b instead of \boldBea Lam2012-08-024-9/+9
| | | | | Change-Id: Ica77b78b113321f962066f1edabd34bf21d38910 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Update docs now that all basic types can also be property typesBea Lam2012-08-021-32/+18
| | | | | Change-Id: I9f90627dc3f83e64e6d1d7b2937fdf5653a063f3 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Document readonly property syntaxBea Lam2012-08-011-1/+28
| | | | | | | Reviewed-by: Chris Adams <christopher.adams@nokia.com> Change-Id: Ibaf68b39526824098aa67f7d1fdce6d12e3b3111 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Document qmlAttachedPropertiesObject()Bea Lam2012-08-012-1/+34
| | | | | | | | 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>
* Doc: Changed \qmlclass to \qmltype and added \instantiates.Jerome Pasion2012-07-303-3/+3
| | | | | | | | | | -To simplify QDoc, \qmlclass is now \qmltype. -'\instantiates <C+++ class>' is for the types that are defined in C++. Change-Id: I29242d33daf7b972d8b86a356b9689638866b950 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Bea Lam <bea.lam@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Improve QML basic types documentationChris Adams2012-07-304-437/+231
| | | | | | | | | | | | | | | 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>
* Clarify use of enumeration type from QML codeBea Lam2012-07-271-3/+31
| | | | | Change-Id: I5aea6ec8c4daada284bc7881bbc3379e5ab61b94 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Update whatsnew documentation with value-type improvementsChris Adams2012-07-271-2/+7
| | | | | | | | | Value types are now supported as property types. QtQuick provides several new value types. Subproperty modification write-back semantics have been fixed for variant properties. Change-Id: Ic47a8401178e6f8bbd5037b6929d7afd5e3cffe6 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Revise the restructured "Integrating QML and C++" docsBea Lam2012-07-2511-1650/+1874
| | | | | | | | | | | | | | | | | These docs were yet to be cleaned up following the recent doc restructure. This changes most of the the content in these sections and includes some new docs and examples. Currently all the code snippets are included inline. In a later patch, these should be moved into the snippets/ directories and be included using the \snippet command instead. Alternatively they can be moved into examples/ to replace the BirthdayParty examples which are no longer referenced in these docs as of this patch. Task-number: QTBUG-26381 Change-Id: I94e3654e61476fad11fe81042d1bbe94fc649d06 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Correctly link the QML module C++ class documentationChris Adams2012-07-247-352/+62
| | | | | | | | | | | | | Previously, the links for in-depth documentation for the various C++ classes led to non-existent pages instead of the correct class documentation. This commit fixes the links to point to the generated class documentation for each class. Also, fix some broken links in the application developer guide essentials section. Change-Id: I2fa9e0c19f645dec696d80387c436c2288b067bf Reviewed-by: Bea Lam <bea.lam@nokia.com>
* More consistent coding style through QML documentation.Yann Bodson2012-07-203-4/+4
| | | | | Change-Id: Ieeda1b22d30917dc9614b34d6ae4d41e0062478b Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Fix links in QML documentation.Yann Bodson2012-07-202-2/+2
| | | | | Change-Id: Ifd6a6cae8b0937548be23f36a23073f2b07e09b2 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Make title capitalization more consistent in QML documentation.Yann Bodson2012-07-2023-81/+81
| | | | | Change-Id: Iec8168135676e0e9e130bd2245ef33fd780829d5 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Add documentation about property value modifiersChris Adams2012-07-194-0/+99
| | | | | | | | | | | 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>
* Doc fix: close code blocks properlyYann Bodson2012-07-191-1/+2
| | | | | | Change-Id: Id4f9e9cb9f37fcc13021c5e6582cf1daaa256438 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Minor doc fixesYann Bodson2012-07-182-6/+6
| | | | | | | Don't capitalize minor words in titles to be consistent with Qt doc. Change-Id: Ib39ec50d7f9730a5bbf2b574ade8270e9290ec90 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Remove the syntax topic page from docsChris Adams2012-07-172-155/+1
| | | | | | | | | This page was superfluous and missing lots of content. This change ensures that we don't link to it, and instead links to the correct subsection of the main page of documentation. Change-Id: I97a944f517fb5d21319811f63c810e0e79cd330c Reviewed-by: Bea Lam <bea.lam@nokia.com>
* QQuickCanvas renamesAlan Alpert2012-07-172-3/+3
| | | | | | | | | | | | | | | | QQuickCanvas is now called QQuickWindow QQuickCanvas::rootItem is now QQuickWindow::contentItem QQuickItem::canvas is now QQuickItem::window QQuickItem::ItemChangeData::canvas is also renamed window QQuickCanvas::grabFrameBuffer is now QQuickWindow::grabWindow The functions related to the color property have dropped the clear from their names. The first three changes have interim compatibility measures in place to ease the transition. Change-Id: Id34e29546a22a74a7ae2ad90ee3a8def6fc541d2 Reviewed-by: Martin Jones <martin.jones@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>
* Improve QtQml module documentationChris Adams2012-07-168-50/+126
| | | | | | | | | | General improvements, including: - fixing broken links - improving topic page content - fixing incorrect qdoc commands Change-Id: I50b6733b51cdabf9cecd96046f6e7f41260a9a4b Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Improve documentation for var propertiesChris Adams2012-07-161-0/+44
| | | | | | | | | | | | | | | Previously, the initialization value assignment semantics of var properties wasn't explicitly documented. Since curly braces on the RHS of an initialization assignment denotes a binding (and curly braces have a different meaning in JavaScript) confusion could result. This commit clearly explains how to initialize a var property with an empty object value. Task-number: QTBUG-23734 Task-number: QTBUG-23388 Change-Id: Ifa94846b170919a0c893f7dda1421c9fb24bd0db Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Improve object attributes documentationChris Adams2012-07-133-221/+526
| | | | | | | | | | | | There is no conceptual difference between custom attributes (custom properties, signals and methods defined in QML object declarations) and non-custom attributes (defined in C++). This change coalesces the documentation for the different attribute types, and also fixes some line wrapping issues. Change-Id: I8cb8d71025e873523cb4389827eef7967e49a626 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Include QQmlExpression in QtQml module CppClasses docsChris Adams2012-07-122-0/+48
| | | | | | | | This commit just adds the structure and the topic page entry. The actual content for the in-depth page has yet to be written. Change-Id: Iee083fe091c612d235bffb64ca38a8e06cc3b9e4 Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Add documentation for all font properties.Michael Brasser2012-07-111-1/+55
| | | | | Change-Id: I575fb6f25a0c926a713b1aa266a2c7ca24368c3e Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Allow color to be explicitly compared to a stringMatthew Vogt2012-07-111-0/+5
| | | | | | | | | | Add the Qt.colorEqual() function which compares any combination of two supplied color and string arguments, by converting the string arguments to colors as necessary. Task-number: QTBUG-18754 Change-Id: I75baef9a2edd30a5f8b9cb5e151e4adba6f6a371 Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Merge old "Modules" docs into new doc structureBea Lam2012-07-117-313/+729
| | | | | | | | | | | | This removes modules/todo.qdoc which contained the old "Modules" documentation page and merges this content into the new Modules documentation. Also cleaned up the structure of the "qmldir" docs. Task-number: QTBUG-26378 Change-Id: Idc8800d0595647eb7064ecadc5a00254341ed1e8 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Document how to register namespaced types with the QML typesystemChris Adams2012-07-111-0/+110
| | | | | | | | | | | Previously, the documentation wasn't clear that C++ types declared in a namespace need to fully qualify any references to namespaced typenames in order for them to be processed correctly by the meta type system. Task-number: QTBUG-15459 Change-Id: I3a1e5c441ad8d4c58e169bdf531cdefb935e7770 Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Improve documentation for JavaScript expressions and importsChris Adams2012-07-115-452/+585
| | | | | | | | | This commit splits the import documentation out of the expression documentation, and corrects various ambiguities or errors in the JavaScript-related documentation. Change-Id: I351b0676f7271efba7cbff90c133dfe008321fb8 Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Fix broken value-type support by allowing property definitionChris Adams2012-07-112-1/+119
| | | | | | | | | | | | | | | | | | | | | In QtQuick 1.x the "variant" property type was supported, which could be used to allow value type properties to be defined in QML. In QtQuick 2.0, we have deprecated the "variant" property, but its replacement ("var") is not suited for defining lightweight C++ type values (such as QColor, QFont, QRectF, QVector3D etc). This commit allows those QML basic types to be used in QML once more, by supporting them in the property definition syntax. Note that since some value types are provided by QtQuick and others are provided by QtQml, if a client imports only QtQml they can define but not use properties of certain types (eg, font). Task-number: QTBUG-21034 Task-number: QTBUG-18217 Change-Id: Ia951a8522f223408d27293bb96c276281a710277 Reviewed-by: Matthew Vogt <matthew.vogt@nokia.com>
* Reorganize "concept" pages in QtQuick docsBea Lam2012-07-053-189/+1
| | | | | | | | | | | | | | | | | This removes concepts/topic.qdoc and move this content into individual concept topic pages under individual directories for each concept to avoid having a really long "concepts" index page. This change also: - Moves components.qdoc ("Defining reusable components") into the appdevguide/ since it's not specific to QtQuick features - it's more about how to use a QtQml feature to build QML apps. - Moves the part of qtqml/doc/src/cppintegration/data.qdoc that discusses how to use C++ models with QtQuick views into quick/doc/src/concepts/modelviewsdata/data-cppmodels.qdoc. Change-Id: Id18a1d56acaaac41714c13cbc94bb3b80f337355 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-26 02:14:46 +0000