aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
Commit message (Collapse)AuthorAgeFilesLines
* Link to JavaScript Environment Restrictions doc from Global Object docsMitch Curtis2015-09-141-2/+2
| | | | | | | | I added the note to the global object documentation in 81dad6e, but I wasn't aware that a more detailed section existed elsewhere. Change-Id: I2b8c1c6ade0d9f27d489a246839ade89ee868a28 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Qt QML documentation: fix link that should be in listMitch Curtis2015-09-101-1/+1
| | | | | Change-Id: Ied44c63fab703db5188ec8f829363a4999f85560 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Document that modifying the globalObject of QQmlEngine is not supportedMitch Curtis2015-09-091-1/+3
| | | | | | Change-Id: I62feb04ae26b6988c6e392b27bd1c3b7f630fd57 Task-number: QTBUG-48175 Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>
* Doc: corrected broken linksNico Vertriest2015-09-081-2/+0
| | | | | | Task-number: QTBUG-43810 Change-Id: Ib47749f95c9ce9db7f2b97726c13ccb9550981e4 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Fix incorrectly formatted code in QQmlEngine documentation.Mitch Curtis2015-08-111-1/+1
| | | | | Change-Id: I70832871cbd697b77cfcbbe425ba5936be1c01d5 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@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>
* Merge remote-tracking branch 'origin/5.4' into 5.5Oswald Buddenhagen2015-07-203-2/+39
|\ | | | | | | | | | | | | Conflicts: tests/auto/quick/qquickwindow/tst_qquickwindow.cpp Change-Id: I272074fa2ca259439cae2f686325932f7f9d7c01
| * Doc: Added the missing \brief and \image to the example docsVenugopal Shivashankar2015-06-021-1/+2
| | | | | | | | | | | | Task-number: QTBUG-41996 Change-Id: Ica6e069c7753a2004a4a4c0e93a49d1f240569d3 Reviewed-by: Martin Smith <martin.smith@digia.com>
| * Doc: Added the missing examples \group page for Qt QMLVenugopal Shivashankar2015-06-023-1/+37
| | | | | | | | | | | | | | | | | | The QHP meta info. was trying to link to the Qt Quick page, which failed. This should fix the issue. Task-number: QTBUG-46163 Change-Id: Ib012f8f73b74a51b7a8d4e849070742e94d40973 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* | Merge remote-tracking branch 'origin/5.5.0' into 5.5Liang Qi2015-06-261-0/+3
|\ \ | | | | | | | | | Change-Id: I4020a1b3c59dea18faf7cbcbb78b90fcfc3680f0
| * | Add left, right, top and bottom properties to basic QML rect type.Mitch Curtis2015-06-031-0/+3
| | | | | | | | | | | | | | | | | | | | | Task-number: QTBUG-45528 Task-number: QTBUG-45530 Change-Id: I83c4056b4bde37ef2dc4424ffddd823c1654d92e Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>
* | | Doc: resize tables with overflowNico Vertriest2015-06-258-8/+25
| | | | | | | | | | | | | | | | | | Task-number: QTBUG-46475 Change-Id: Iebb2f7677f8b514d2b3e08480abfc98a0e155c1c Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* | | Doc: document work-around for static builds using dynamic object creationRichard Moe Gustavsen2015-06-181-0/+9
|/ / | | | | | | | | | | | | | | | | Currently we have no system to detect import dependencies that are not explicitly added to a QML file (other than qmldir "depends", which is for plugins only). Until we do, document the work-around. Change-Id: Ic7244728b63bd1f2eb4bf9734474b3e6e48e26fe Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>
* | Purge use of VisualDataModel from docs where DelegateModel is requiredAlex Blasche2015-05-283-7/+10
| | | | | | | | | | | | | | | | | | They are the same types except that VisualDataModel is deprecated and uses a different import statement. Now, references to VisualDataModel are only used where we explicitly refer to the replacement/deprecation. Change-Id: I1e68eb5784235a00233b3882c3d91e21e32af7d1 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | Merge remote-tracking branch 'origin/5.4' into 5.5Simon Hausmann2015-04-271-1/+1
|\| | | | | | | | | | | | | | | Conflicts: .qmake.conf tests/auto/qml/qqmlxmlhttprequest/tst_qqmlxmlhttprequest.cpp Change-Id: I715b8a78b74cbe0dcaf599367fd6e08af4858e11
| * Doc: corrected error on return value qmlRegisterTypeNico Vertriest2015-04-241-1/+1
| | | | | | | | | | | | Task-number: QTBUG-45584 Change-Id: I97508aabe47c49d8e27329a7856dd921ee0505dd Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Doc: Expand on QJSEngine exception handlingSze Howe Koh2015-04-181-1/+4
| | | | | | | | | | | | | | | | | | | | | | - List the properties provided by the Error object. They consist of the standard properties and a subset of the Mozilla extensions. - Add QJSValue::property() usage to the example code. - Add cross-referencing. - Some rephrasing for clarity and conciseness. Change-Id: I1eb6943899fee2bd81851ccb03660a7a474a975d Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
* | Fix some qdoc warnings.Friedemann Kleint2015-03-311-1/+1
| | | | | | | | | | | | | | | | | | | | | | qtdeclarative/src/qml/qml/qqmlinfo.cpp:46: warning: Cannot find 'qmlInfo(...)' in '\fn' QQmlInfo qmlInfo(const QObject *object) qtdeclarative/src/qml/qml/qqmlexpression.cpp:366: warning: Undocumented parameter 'column' in QQmlExpression::setSourceLocation() qtdeclarative/src/qml/doc/src/qmlfunctions.qdoc:176: warning: Undocumented parameter 'reason' in qmlRegisterExtendedUncreatableType() qtdeclarative/src/qml/doc/src/qmlfunctions.qdoc:176: warning: No such parameter 'message' in qmlRegisterExtendedUncreatableType() Change-Id: Iec801b33b11bd57abadd968a90c49f8eba1280d5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Alan Alpert (Personal) <416365416c@gmail.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>
* | Doc: Removed the release notes for Qt Quick and Qt QmlVenugopal Shivashankar2015-03-091-130/+0
| | | | | | | | | | | | | | | | | | | | | | | | These pages were not maintained and were duplicating info. provided in the what's new page provided for each release. Change-Id: I2ee4010de22ef3fb394e3bcdb6adb15db59a2cc9 Task-number: QTBUG-43235 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Sami Makkonen <sami.makkonen@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | Merge remote-tracking branch 'origin/5.4' into 5.5Frederik Gladhorn2015-02-245-15/+11
|\| | | | | | | | | | | | | | | | | | | | | 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-043-7/+1
| | | | | | | | | | | | Task-number: QTBUG-43810 Change-Id: I154ffa83512435c3e455937a3f81931a45d9e368 Reviewed-by: Martin Smith <martin.smith@digia.com>
| * Doc: link issues qtdeclarativeNico Vertriest2015-01-201-1/+1
| | | | | | | | | | | | | | | | Added modules to depends stat. qtquick.qdocconf Task-number:QTBUG-43810 Change-Id: If6010a382e2c9011b7599f25eb31ba9c9c3b3eb0 Reviewed-by: Topi Reiniö <topi.reinio@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>
* | Fixed license headersJani Heikkinen2015-02-17105-315/+315
| | | | | | | | | | Change-Id: I4d5640ff95e1361ec7e65fb3e87d7726d8185ff5 Reviewed-by: Sergio Ahumada <sahumada@texla.cl>
* | Doc: Bump QtQuick import version to 2.5Shawn Rutledge2015-02-121-1/+1
| | | | | | | | | | | | Change-Id: I9b41d6c755f804aeb47564f10d7131df528ba61d Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com> Reviewed-by: Caroline Chao <caroline.chao@theqtcompany.com>
* | 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-27 09:36:29 +0000