aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/qmllanguageref
Commit message (Collapse)AuthorAgeFilesLines
* Give SquareButton types a side property to mediate being square.Edward Welbourne2016-09-213-5/+9
| | | | | | | | | | | | | | We shouldn't be setting width and height for each square; we should only need to set their side, which determines their width and height - so that they're actually square ! More pertinently, this could later serve as an illustration of how to use properties and bindings. Ideally, we'd do this in some way that actually ensures setting width or height changes side; but the simple approach will do for now. Change-Id: I0df89e11221dde5d1d2930c4a779b59cf0d46654 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Document that attached properties are created in C++Mitch Curtis2016-09-051-1/+2
| | | | | | | | | | | | There was some uncertainty about whether or not it could be done from QML, which it can't. This patch also links to the documentation for creating custom attached objects. Change-Id: Icb9eff0ec96e7911b8d401bd38813bbd6eda227d Reviewed-by: Gavin Kistner <gkistner@nvidia.com> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Fix typo in QML alias documentationMitch Curtis2016-04-121-1/+1
| | | | | Change-Id: I9e8b4cb7fe2151b7b3da19dd15641bf76a69042b Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Fix grammar in QML property aliases documentationMitch Curtis2016-02-111-2/+2
| | | | | Change-Id: Ifa5c046d389f8f4b538b5b7727b99a0dd26a6121 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Added link to Extending QMLNico Vertriest2015-11-201-2/+1
| | | | | | Task-number: QTBUG-33521 Change-Id: I616369c3a535395ddb465a2f787dec7fc055a503 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: corrected typo in doc basic typesNico Vertriest2015-10-301-1/+1
| | | | | | Task-number: QTWEBSITE-517 Change-Id: I5177d45f294566e9551e08755ef627008e86cd35 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: replaced \keyword with \target when not at top of pageNico Vertriest2015-09-283-4/+4
| | | | | | | Change-Id: I20bc53c71d6c3217ec51a3fd5ad8e5a38bb2043b Task-number: QTBUG-48482 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Make QQmlExtensionPlugin documentation clearer.Mitch Curtis2015-08-071-6/+13
| | | | | | | | | | | | | | | | | | I spent too long wondering why my plugin wasn't being loaded, until I realized that the directory I was installing the qmldir into was not named the same as the module. This is already documented in the "Module Definition qmldir Files" documentation: http://doc.qt.io/qt-5/qtqml-modules-qmldir.html#contents-of-a-module-definition-qmldir-file But as I was writing a plugin, I was following this documentation: http://doc.qt.io/qt-5/qtqml-modules-cppplugins.html Where it was not at all obvious that they should be named the same. Change-Id: I3e20bc31f8b42c7141b4c22c8cb1750ba9782971 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Rephrase sentence about versioning in QQmlExtensionPlugin documentationMitch Curtis2015-08-031-1/+1
| | | | | | | | The original sentence (885735d0) is better than the new one (2c4c7a38). Some small adjustments were made in this patch as well. Change-Id: I2cc62c2ffcde7df289b07486439456350a2f60ab Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Consolidate duplicated QQmlExtensionPlugin documentation.Mitch Curtis2015-08-032-84/+84
| | | | | | | | There have already been doc improvements made to one of the duplicated pieces and not the other. This patch uses the improved one. Change-Id: I12a6cb013e61f63e67fb9d691ee58ba12e21054d Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Fix typo in plugin documentation.Mitch Curtis2015-08-031-1/+1
| | | | | Change-Id: I5cd851e493b6663bd0a7d09a1c5435c37a4ad7d6 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: resize tables with overflowNico Vertriest2015-06-251-1/+1
| | | | | | Task-number: QTBUG-46475 Change-Id: Iebb2f7677f8b514d2b3e08480abfc98a0e155c1c Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Removed a col from the table of qmldir statementsVenugopal Shivashankar2015-03-241-14/+2
| | | | | | | | | | | The table was too wide for the online template, which limits the width to 80 columns. Removed a redundant column in the table so that the readability improves in online version of the doc. Change-Id: I633cd81225333d814b1d47aa155130b8d6958e3e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Added info. about the singleton type declarationVenugopal Shivashankar2015-03-191-4/+28
| | | | | | | | Task-number:QTBUG-37057 Change-Id: I458bc4fe3920b70c201da0a09b437965b651872e Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com> Reviewed-by: Caroline Chao <caroline.chao@theqtcompany.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Merge remote-tracking branch 'origin/5.4' into 5.5Frederik Gladhorn2015-02-243-13/+10
|\ | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf LICENSE.GPLv2 examples/qml/networkaccessmanagerfactory/view.qml src/qml/jsruntime/qv4runtime.cpp src/qml/jsruntime/qv4stringobject.cpp Change-Id: I5d12f436d60995e51d5c2f59d364e9cbc24f8e32
| * Doc: link issues qtdeclarativeNico Vertriest2015-02-041-5/+0
| | | | | | | | | | | | Task-number: QTBUG-43810 Change-Id: I154ffa83512435c3e455937a3f81931a45d9e368 Reviewed-by: Martin Smith <martin.smith@digia.com>
| * Fix and improve links to Component::completedAlejandro Exojo2015-01-202-8/+10
| | | | | | | | | | Change-Id: I39771b861c529550c59f142c054b108f7a8bc7ff Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | Update copyright headersJani Heikkinen2015-02-1220-120/+120
| | | | | | | | | | | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Change-Id: I61120571787870c0ed17066afb31779b1e6e30e9 Reviewed-by: Iikka Eklund <iikka.eklund@theqtcompany.com>
* | Doc: Remove text that claims aliases cannot be read-onlySimon Hausmann2014-11-241-2/+2
|/ | | | | | | | It's very well possible to have read-only aliases :) Task-number: QTBUG-33709 Change-Id: I2ad8854cd0b412d1d2e7afde6dfd585519b69e27 Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Doc: Qt Quick Designer UI formsLeena Miettinen2014-11-031-0/+6
| | | | | | | | | | Since Qt Creator 3.3 and Qt 5.4, Qt Quick Designer handles .ui.qml files that are similar to the .ui files of Qt Designer. Change-Id: I147e82a111ca7d3b806c4c6c94cc73b35a67785b Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com> Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
* documentation for qmldir "depends" declarationShawn Rutledge2014-10-011-0/+19
| | | | | | | | | | [ChangeLog][QtQml][qmldir] added the ability to declare dependencies on other modules in a module definition qmldir file Task-number: QTBUG-41489 Change-Id: Icd526bc7617bc3e4f725c7d008d0522a201cf645 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix example in scope documentationSimon Hausmann2014-09-301-2/+2
| | | | | | | | | | | | | The example tried to demonstrate the use of direct access to properties of the root component object, but unfortunately it also defined an id property that clashed with it. Therefore the provided example did not work as intended and produced a "stringified" object reference instead of the text of the "title" property. This patch changes the id to avoid a clash. Change-Id: Ib9abcf48482773a0dcdf5e2375d1445d87ccf4ef Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Doc: apply title case to all section1 titlesNico Vertriest2014-09-241-1/+1
| | | | | | Task-number: QTBUG-41250 Change-Id: I303d989992c9685f73baae50c64accf71b43549f Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Add new property "designersupported" to qmldirTim Jenssen2014-08-281-0/+22
| | | | | | | | | | | | | | | | | This patch adds a property called "designersupported" to qmldir. This allows the Qt Quick Designer to only load plugins that have the line ""designersupported"" in their qmldir file. So the designer can load sub components without risking to load plugins that have never been tested in the designer and that might crash. The check for "designersupported"" is activated by using QQmlImports::setDesignerSupportRequired(). Change-Id: I4bf07cc163faa47996eacb1365a7961c51c51060 Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com> Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
* Doc: fixed a broken tableLeena Miettinen2014-08-131-0/+1
| | | | | | | | In "Importing QML Document Directories" by adding a missing \row command. Change-Id: Ie98ee34b2f66472b0ca692d2acdea870247448a0 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Remove duplicated wordsTopi Reinio2014-08-122-2/+2
| | | | | | | | Removes duplicated (repeated) words and fixes other minor documentation issues. Change-Id: I891f2b3e60194b207737425c1dcc1d35a5bd921a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Docs: fix "classname" indentation in the qmldir specsJ-P Nurmi2014-07-091-1/+1
| | | | | Change-Id: Idaaaaa77654c2cd3abb56d0bfd3ed7bac7281632 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: correct link/compilation errors in Qt DeclarativeNico Vertriest2014-07-024-13/+10
| | | | | | | Task-number: QTBUG-34749 Change-Id: I507d54b0568d77c6099a0bd99f5c369b8667032a Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Polish property binding explanationsSze Howe Koh2014-05-162-44/+31
| | | | | | | | | - Minor rearrangements - Express things more clearly and/or concisely - Add links Change-Id: If1ed639609e39ed1a2c12aed3971da3ee2c8f8a0 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Describe property bindings in terms of relationshipsSze Howe Koh2014-05-162-22/+54
| | | | | | | | | | | | | | | | | | | | | | | - This patch aims to help readers think about bindings more "declaratively" by introducing a new (albeit very leaky) level of abstraction: Treat bindings as finitary relations, rather than mere JavaScript expressions. - In essence, property bindings are for describing relationships between properties. The fact that the QML engine reactively updates a property's value when its dependencies change, and the fact that arbitrarily complex expressions are valid bindings, are simply implementation details. - Discourage the use of side effects in property bindings. They are not essential for the main purpose of property bindings, they break the finitary relation model, and their use can reduce code readability/maintainability/toolability. - Discourage complex property bindings for similar reasons. Change-Id: I5a0a03bd02768d4c504797a0f86569f3ac066e96 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Remove references of QML as a 'declarative' languageKai Koehne2014-05-072-10/+14
| | | | | | | | | | | | Though the core of QML is declarative, it incorporates JavaScript, a multi-paradigm language on its own. It's therefore correct to call it a multi-paradigm language, too. Change-Id: Ia72acedafefb68ea8c49b9f6ab195ca9e73dad5f Reviewed-by: hjk <hjk121@nokiamail.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Christopher Adams <chris.adams@jollamobile.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Fix some documentation errors.Friedemann Kleint2014-03-241-5/+5
| | | | | Change-Id: I5d4b3e26742202c4b634d0001fd3658c7263c50a Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Fix broken \qmlsignal linksSze Howe Koh2014-03-182-2/+2
| | | | | | | | Fix the breaks caused by the re-categorizing of \qmlsignal pages Task-number: QTBUG-35846 Change-Id: I528ae16ec522fc902133e22d8f53c87a7f0d56ad Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Fix some typosSergio Ahumada2014-03-034-5/+5
| | | | | Change-Id: Iea540b768232ea423ea7f04e41655198931cf36d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Added information about classname in qmldirVenu2014-02-121-1/+13
| | | | | | | | | | | | QML modules that depend on C++ plugins must provide the plugin class name information in their qmldir to support statically built Qt Quick applications. Task-number: QTBUG-35369 Change-Id: I15432fec4f8a72be4f851da061ac0c091696d8c9 Reviewed-by: Morten Johan Sørvig <morten.sorvig@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Merge duplicated example directoriesSze Howe Koh2014-02-061-1/+1
| | | | | | | | | | | | | | | examples/quick/customitems contains all the examples found in examples/quick/ui-components, plus 2 more (maskedmousearea and painteditem). There are some very minor differences between the duplicated files, regarding the "smooth" property. Apart from that, the examples are identical. The only file that is unique to examples/quick/ui-components is example-slideswitch.qdoc. Moving it does not change the generated HTML filename. The other examples do not produce any documentation. Change-Id: I507d9064a60fd1f3a1469c1e423d4c0a72c7dc41 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix some typos in documentation.Jeff Tranter2014-01-091-1/+1
| | | | | | | | | Fix some spelling and grammatical errors in comments that show up in Qt documentation. No changes to code. Change-Id: I2d91518900c9b60ee8e8a8f549c88a1d50632b3d Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Ameliorate DocumentationAlan Alpert2014-01-071-2/+3
| | | | | | Task-number: QTBUG-33438 Change-Id: I9187513d3b4c68d99c90726288653aae5c553a67 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Doc: Fix broken linksSze Howe Koh2013-12-306-11/+13
| | | | | Change-Id: I4c4577edde96978a986606bf30fbb925f871bd42 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Fix broken linksSze Howe Koh2013-11-051-1/+1
| | | | | | Change-Id: Ie7408409ddbaa354370267f2dd74326ec56a4186 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Link to QML Qt object in relevant locationsTopi Reinio2013-07-251-0/+2
| | | | | | | | | | 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>
* 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: Fix some broken snippet pathsSze Howe Koh2013-05-061-2/+2
| | | | | Change-Id: Ib79bfbea402b86e26a503de47383522317ca906b Reviewed-by: Jerome Pasion <jerome.pasion@digia.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: Qt Quick: Fix module name format (Pt 1/2)Sze Howe Koh2013-04-235-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: Refactored and focused the Qt QML documentation.Jerome Pasion2013-04-2320-0/+4991
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-02 23:15:05 +0000