aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update copyright headersJani Heikkinen2015-02-12152-795/+795
| | | | | | | | | 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>
* Merge remote-tracking branch 'origin/5.4' into devSimon Hausmann2015-01-165-6/+67
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf src/qml/jsruntime/qv4context_p.h src/qml/jsruntime/qv4debugging.cpp src/qml/jsruntime/qv4engine.cpp src/qml/jsruntime/qv4functionobject_p.h src/qml/jsruntime/qv4qobjectwrapper.cpp src/quick/scenegraph/shaders/visualization.frag tests/auto/qml/qjsengine/tst_qjsengine.cpp Change-Id: I492e8546c278f80a300a2129e9a29d861e144a30
| * doc: Fixed copy/paste errors in DSM snippetsAlejandro Exojo2014-12-303-3/+0
| | | | | | | | | | | | | | | | | | The comments make sense only for the first button, the one that changes the text label. Change-Id: I984f3eff7c797cbccafcba2a0eeaaff9001094e6 Reviewed-by: Brett Stottlemyer <bstottle@ford.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
| * Mark qmlRegisterCustomExtendedType as \internalAlejandro Exojo2014-12-121-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The function was added in 5.4, but it makes use of QQmlCustomParser, which at the moment is private API. This way Qt3D or bleeding edge users can still use the function, while keeping freedom to change QQmlCustomParser. Since 5.4.0 had the typo in the \relates, users won't see a change from 5.4.0 to 5.4.1. Change-Id: I7f791f5b39e2a2c9fc83f4c450e6da9eec5b5e46 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
| * Restore extension types documentationAlejandro Exojo2014-12-102-3/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The documentation on QML extension types was accidentally removed on the big restructuring of commit 28def0bdd084989c17a157e0c4ab80c259081caa. This restores it to a section on the "Defining QML Types from C++" page mostly unchanged, and makes the source of the example that was already there visible. The reference documentation of the qmlRegisterExtendedType is added as well, and the one for qmlRegisterExtendedUncreatableType and qmlRegisterCustomExtendedType that was added in fcb40ff6d71f4561401e6b2bd4d7fc706fff8eee is now fixed. It was not being generated because referred to "QQmlEgine" instead of "QQmlEngine". Change-Id: I1403b10076c64a4c0d760f72b06dd52c38b351a5 Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* | Enable gadget wrapping for custom value typesSimon Hausmann2015-01-021-0/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [ChangeLog][QtQml] Custom C++ value types annotated with Q_GADGET are now fully accessible in the QML and QJSEngine JavaScript environment. QJSEngine::toScriptValue can be used for injection and fromScriptValue to extraction. The QML "built-in" gadget wrappers for QPoint and the gui types are not exposed this way, toScriptValue(point) will still return an opaque QVariant wrapper. We could expose the core types right away, but then we would be lacking an API to enable use of the Gui types that are registered in QtQuick. It would be better to make the core types in qtbase gadgets and thus enable them without the need for hooks and init functions to be called by the user. Task-number: QTBUG-29769 Change-Id: I8179cd599bdc1209ff61cfdbdda419cb400296bb Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* | support XMLHttpRequest sync modeTasuku Suzuki2014-12-261-1/+0
| | | | | | | | | | | | | | [ChangeLog][QtQml][XMLHttpRequest] Supported synchronous requests Change-Id: Ia38fcf97f212a14657bb519240d8406368a72390 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* | Document behavior of JavaScript Date with negative yearsUlf Hermann2014-12-121-0/+19
| | | | | | | | | | | | Task-number: QTBUG-29491 Change-Id: Icc9620abc3bc606f1cd0ab89762f370ac259893e Reviewed-by: Mitch Curtis <mitch.curtis@digia.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>
* Doc: Updated the code snippets for the toLocalexxx functionsVenu2014-10-241-3/+3
| | | | | | | | | | Using Date() as a regular function without the new operator returns a string and not a date object. Change-Id: I083bb62c0cb3041a053d43e3085c3d0d10423db6 Task-number: QTBUG-41712 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Fixed an error in the QML snippetVenu2014-10-231-6/+6
| | | | | | | | | | | Also updated the C++ snippet to look like a gui app that shows the QML example, instead of a console app that just provides the context data to the QML example. Change-Id: I17aca9f03521cfcadba1a965a4924e87cbf14c62 Task-number: QTBUG-41699 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix non-compiling QtQml code snippetAlex Blasche2014-10-231-1/+1
| | | | | | | Task-number: QTBUG-42006 Change-Id: I3c59b0ba27518750cba667f414f58edaa136d250 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qmlstatemachine: Rename StateBase to StateKevin Funk2014-10-2113-71/+102
| | | | | | | | | | | | As discussed with Brett Stottlmyer and Alan Alpert. Add a section about the implications when importing both QtQml.StateMachine and QtQuick in one single QML file. Change-Id: I8755f4b578e2a6ff4c2377c7a8a0b996ba9b7129 Reviewed-by: BogDan Vatra <bogdan@kde.org> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Doc: Updated the QML State Machine docsVenu2014-10-091-106/+85
| | | | | | | | | | | | | | - Excluded the src/imports/statemachine directory from qtquick.qdocconf to avoid unnecessary qdoc warnings. - corrected a broken link to an external source - changed the group name to avoid collision - added a \qmlmodule page for QtQml.StateMachine - Reduced the amount of duplication between the C++ and QML state machine overviews. Task-number: QTBUG-41561 Change-Id: I87c815fada7006f0609331e315bb338f062bb4db Reviewed-by: Topi Reiniö <topi.reinio@digia.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>
* Doc: Combine the extending QML tutorial chapters into a single exampleTopi Reinio2014-09-301-113/+75
| | | | | | | | | | | | | Combine the six examples associated with each tutorial chapter into a single, top-level example project 'extending-qml', with subprojects for each of the tutorial chapters. Clean up the docs, add links, and a note about a warning that the user may see when running the code in the first chapter. Task-number: QTBUG-32947 Change-Id: Idba4e2153817ab29f1afaf1947d1f2e25964e7b3 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@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-243-3/+3
| | | | | | Task-number: QTBUG-41250 Change-Id: I303d989992c9685f73baae50c64accf71b43549f Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix broken QJSEngine snippet in documentation.Mitch Curtis2014-09-111-3/+3
| | | | | | | | toBoolean() isn't even a function in that class, and declaring the button on the stack causes crashes upon closing the application. Change-Id: I063cac2bb144cfb9786f20bbc122d5af92a4c2c0 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@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>
* QSM: Reintroduce guard argument evaluationSebastian Sauer2014-08-251-0/+69
| | | | | | | | | | | | | | Implements the suggestion from Simon Hausmann (codereview 89716 from 08-05 14:46) to use QQmlScriptString rather then the previous used MetaObject-manipulation. This also introduces comparison operators for QQmlScriptString to be able to determinate if a QQmlScriptString changed what is needed cause there is otherwise no way to access (all) the needed details within QQmlScriptStringPrivate. Change-Id: I198479eac8fd37cbdd98a99aacdd8eebf7b75d21 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Doc: Removing url variable from qdocconf file.Topi Reinio2014-08-161-1/+0
| | | | | | | | -url inherited from the url variable set in qtbase/doc/global Change-Id: I94a0da7aa98af1fdd6140168fe9feb27b11c0bdb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@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: Add a keyword for XMLHttpRequestTopi Reinio2014-08-121-1/+1
| | | | | | | | | | To make the search term 'XMLHttpRequest' return relevant results in the Assistant, add a keyword for it. Task-number: QTBUG-40240 Change-Id: I44b0d397cd014d2468e6302d4293c959ec8c8802 Reviewed-by: J-P Nurmi <jpnurmi@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Remove duplicated wordsTopi Reinio2014-08-127-7/+7
| | | | | | | | Removes duplicated (repeated) words and fixes other minor documentation issues. Change-Id: I891f2b3e60194b207737425c1dcc1d35a5bd921a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Say hello to the Declarative State Machine FrameworkBrett Stottlemyer2014-08-0821-1/+1403
| | | | | | | | | | | | | | | | | | The Declarative State Machine Framework extends Qt's State Machine Framework (QSM) into QML to provide types for creating and executing state graphs in QML. This gives you the power of deterministic state machines, but declaratively and without having to write all of the boilerplate code. It is an alternative to the existing QML State type, intended for more complex models. [ChangeLog][QtQML] The Declarative State Machine Framework extends Qt's State Machine Framework (QSM) into QML. This gives you the power of deterministic state machines, but declaratively. Change-Id: I02390ba7f1baed50935364530925bd75087299cb Reviewed-by: Sebastian Sauer <sebastian.sauer@kdab.com> Reviewed-by: BogDan Vatra <bogdan@kde.org> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* qmlRegisterCustomExtendedType, qmlRegisterExtendedUncreatableTypePaul Lemire2014-07-251-0/+38
| | | | | | | | | | | | | | | | | | There are cases in Qt3D where we'd like to be able to register uncreatable extended types. The main use case is having an abstract class that has an extension class so as to have a clean separation between the C++ and QML API. Implementations of the abstract can then be easily registered to QML and rely on the extension class for QML specific properties. The other feature we'll need in the near future is the ability to create extended QML types that use a custom parser. Two new type registration method were added to qqml.h to fulfill those needs. Unit tests for those are present in qqmlecmascript and qqmllanguage. Change-Id: I15b2cd791ffd36b537305af1873491c079d4094e Reviewed-by: Sean Harmer <sean.harmer@kdab.com> Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Merge remote-tracking branch 'origin/5.3' into devFrederik Gladhorn2014-07-106-16/+14
|\ | | | | | | Change-Id: Iba61035910c46627e5e1c3824757da7b3d573657
| * 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-026-15/+13
| | | | | | | | | | | | | | Task-number: QTBUG-34749 Change-Id: I507d54b0568d77c6099a0bd99f5c369b8667032a Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'origin/5.3' into devFrederik Gladhorn2014-07-021-1/+1
|\| | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf examples/quick/scenegraph/openglunderqml/squircle.h src/quick/doc/src/qmltypereference.qdoc src/quick/scenegraph/qsgthreadedrenderloop.cpp Change-Id: Ife4f4b897044a7ffcd0710493c6aed1d87cf1ef9
| * Merge remote-tracking branch 'origin/stable' into 5.3Frederik Gladhorn2014-06-251-1/+1
| |\ | | | | | | | | | Change-Id: Iafccb173a9b5569bc9fd1022abb210955519fc61
| | * Update QtQuick import value to 2.3Samuel Gaist2014-06-231-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current documentation uses import QtQuick 2.2 which is wrong since there are new APIs like mipmap for the QML Image element. Task-number: QTBUG-39302 Change-Id: I3cc3a1522efd85090c3b4011429fa16b95e79435 Reviewed-by: J-P Nurmi <jpnurmi@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | | Merge remote-tracking branch 'origin/5.3' into devSimon Hausmann2014-06-134-50/+48
|\| | | | | | | | | | | | | | | | | | | | Conflicts: src/quickwidgets/qquickwidget.cpp Change-Id: Id4b080aea713df68608847bb82570231e37ce536
| * | Doc: Clarify where JavaScript fits in QML codeSze Howe Koh2014-06-132-47/+42
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Rewrite the introductory list. - Rewrite the section about application startup code. - Flatten sections. Previously, there were two \section1 headings: "JavaScript Expressions in QML Objects" and "Running JavaScript at Startup". This split wasn't very natural, as startup code needs to be called from an object, while imported JS files aren't in objects. - Some minor formatting/wording changes in unrelated areas. Change-Id: Ie08f94e2ea77ca84f80491c782bc30612f7ef698 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * add missing signal declaration in Exposing Attributes to QML exampleShawn Rutledge2014-06-101-0/+2
| | | | | | | | | | | | Task-number: QTBUG-33985 Change-Id: Id6a2a51467ee5de44bf51fb48e3f9346a832f8f2 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Doc: Updated "Qt Quick Examples" pages.Jerome Pasion2014-06-051-3/+4
| | | | | | | | | | | | | | | | | | | | | | -added instructions about running the example (using \include) -used the example names as sections in the collection pages -general editing and documentation polishing -updated copyright information Change-Id: I044f29fcc1921a541040505d5821acb06dc4cb35 Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Doc: Fix qmlclass selector used in documentation configTopi Reinio2014-06-111-1/+1
|/ | | | | | | | | | A recent change (46959875) in qdoc raised QML types from subnodes to top-level nodes. This change modifies the documentation configuration file(s) accordingly. Change-Id: Ic457d20368979aa15b546dceaf84fa2fb2d31091 Reviewed-by: Jerome Pasion <jerome.pasion@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-165-48/+78
| | | | | | | | | | | | | | | | | | | | | | | - 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>
* Doc: Remove references to the unimplemented 'time' typeSze Howe Koh2014-04-301-3/+0
| | | | | | | Task-number: QTBUG-32295 Change-Id: Iedd61d0494aeebd6d99a39f4eb81e7461c20a079 Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Doc: Document signals (not handlers) under \qmlattachedsignalSze Howe Koh2014-03-281-2/+2
| | | | | | | | | | - They're not "attached properties" either. - Append the handler names to the end of the corresponding signal doc. - Update descriptions and links Task-number: QTBUG-35846 Change-Id: I54e93187b3209546ec344a20e0482c98d7f14109 Reviewed-by: Jerome Pasion <jerome.pasion@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-183-7/+7
| | | | | | | | 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-036-7/+7
| | | | | Change-Id: Iea540b768232ea423ea7f04e41655198931cf36d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Renamed Qt Quick Code Samples page.Jerome Pasion2014-03-031-1/+1
| | | | | | | | | -new name is Qt Quick Examples and Tutorials -includes tutorials, not just examples or code samples. Task-number: QTBUG-36838 Change-Id: I660770cac1cdd71cd3b34bad878b0e59a088924b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Merge remote-tracking branch 'origin/stable' into devSimon Hausmann2014-02-181-1/+13
|\ | | | | | | | | | | | | | | Conflicts: src/qml/jsruntime/qv4functionobject.cpp src/quick/scenegraph/coreapi/qsgbatchrenderer_p.h Change-Id: Id164f6c3b45501aa466908659ec4e3b957323753
| * 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-21 07:43:13 +0000