aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/snippets/qml
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Remove misleading example about alias overridingUlf Hermann2025-09-301-25/+0
| | | | | | | | | | | Apparently the author wanted to show an alias overriding a property and still retain control over the property. This doesn't work and simply confuses any reader. Pick-to: 6.10 6.8 Change-Id: Id63708eb7623d4cd24a81135156b237d85f2ca74 Reviewed-by: Dmitrii Akshintsev <dmitrii.akshintsev@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Replace nokia.com logo URLs with something that works for nowShawn Rutledge2025-09-261-1/+1
| | | | | | | | | If only the qt.io website could be relied upon to have a Qt logo in the same path for eternity... Pick-to: 6.8 6.10 Change-Id: Ie221bd85152af42bdf36655083932ca8341c7d2a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add easingCurve value type and Easing singletonMitch Curtis2025-06-252-0/+84
| | | | | | | | | | | | | | This allows defining easing curves from QML, which is useful for e.g. FrameAnimation or use cases that require non-linear progression. [ChangeLog][QtQml] Added the easingCurve value type and Easing singleton. Fixes: QTBUG-137468 Change-Id: I2f9c4c2269c80c31a70700dd3a2475c53ba8a930 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: De-nokia-fy QML import documentation snippetJoerg Bornemann2025-04-101-1/+1
| | | | | | | | | | The text on the page "Identified Modules" has already been updated to use com.mycompany.qml.mymodule as example URI. The snippet that's included at the top of the page has been missed. Pick-to: 6.8 6.9 Change-Id: I05df857d8f9df24e70dafa6b8de3353736d268fb Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Add source string template code snippet for qsTrIdAndreas Eliasson2024-10-091-4/+13
| | | | | | | | | | | Add code snippet for how to supply source string templates to Qt::qsTrId using /*% <string> */. The /begincomment and /endcomment expand to /* and */, respectively. Fixes: QTBUG-127794 Pick-to: 6.8 6.7 6.5 6.2 Change-Id: I84b77179892eea6dba2c8816b658916d665e718e Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Doc: Add snippet that shows how to use the n param in qsTr()Andreas Eliasson2024-10-021-1/+11
| | | | | | | Fixes: QTBUG-127795 Pick-to: 6.8 6.7 6.5 6.2 Change-Id: I4b9a958805b4bdcd0b06758e94aca5278847c314 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Document that properties in functions used as bindings will be re-evaluatedMitch Curtis2024-06-211-0/+18
| | | | | | | | This was not obvious to me, so documenting it may help others out. Pick-to: 6.8 6.7 6.5 Change-Id: I11f985627d6168ad9a808c450c694de3ca72bcfb Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Correct doc snippet licenseLucie Gérard2024-03-221-1/+1
| | | | | | | | | | | | | | All file under doc/snippet should be license as Documentation snippets and according to QUIP-18 [1] thi is LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 6.7.0 Task-number: QTBUG-121787 Change-Id: Iee9bc9b8c2a81695c5825a36768b36db2726bd35 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Remove confusing and wrong section about aliasesUlf Hermann2024-02-201-13/+2
| | | | | | | | | I cannot figure out what this was supposed to mean. Pick-to: 6.7 6.6 6.5 Fixes: QTBUG-119448 Change-Id: Iac8ede669d5b09c674abf115f13f977f854b7d96 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: Remove unused snippet fileKai Köhne2023-06-301-24/+0
| | | | | Change-Id: Icdb5f01e9f3180fb398c100ba763b9a0ce8be2a1 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Don't use versioned Qt imports in QML snippetsKai Köhne2023-06-3058-64/+64
| | | | | | | | | | | We don't promote versioned imports anymore in Qt 6. Patch done by find . -path "*/snippets/*.qml" -exec perl -pi -e "s/import Qt([\.a-zA-Z]*) \d\.\d+/import Qt\\1/g" {} ; Pick-to: 6.5 6.6 Change-Id: I20a5bf52f7cdd99124626f85ce9794af74382977 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Convert XMLHttpRequest example to a snippet and add doc pageOliver Eftevaag2023-03-032-0/+108
| | | | | | | | | | | | | The XmlHttpRequest is poorly documented, and should have its own documentation page, instead of being part of the qml global object page. The XmlHttpRequest example might as well be converted to a snippet, that can be present on the new doc page. Fixes: QTBUG-110003 Pick-to: 6.5 6.5.0 Change-Id: I0ffee43046d4fb71e64f04008b444e11dc8b21ff Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Update QQmlContext documentation to discourage context propertiesUlf Hermann2023-02-084-0/+104
| | | | | | | | | | The snippets showing the use of setContextProperty() are intentionally removed. You should not do such a thing. Pick-to: 6.5 Fixes: QTBUG-106030 Change-Id: I1c5c217630aee8dd6e44f9f244b9ef2a8d2ef290 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* qt_add_qml_module: Make usage of AUTO_RESOURCE_PREFIX a policyFabian Kosmale2023-02-011-1/+2
| | | | | | | | | | | | | | | | Writing AUTO_RESOURCE_PREFIX in every qt_add_qml_module call seems rather pointless. In addition: - Add documentation for QTP0001. - Adjust some of the examples to use QTP0001 policy. - Improved the error message. Pick-to: 6.5 Task-number: QTBUG-96233 Change-Id: I6e19a491acba97493893bf1953fca3462296c1ea Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Change the license of all CMakeLists.txt and *.cmake files to BSDLucie Gérard2022-09-071-1/+1
| | | | | | | Task-number: QTBUG-105718 Change-Id: Id89ed14990804a5024183e75382cc539d4293da1 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Add license headers to cmake filesLucie Gérard2022-07-081-0/+3
| | | | | | | | | | | | CMakeLists.txt and .cmake files of significant size (more than 2 lines according to our check in tst_license.pl) now have the copyright and license header. Existing copyright statements remain intact Task-number: QTBUG-88621 Change-Id: I72c89a98c42bbc9234d8495e9e503bec81d11037 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-1179-3855/+165
| | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: I63563bbeb6f60f89d2c99660400dca7fab78a294 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Write QML ModulesJaishree Vyas2022-03-315-0/+76
| | | | | | | | | | Based on a Blog post Task-number: QTBUG-100450 Pick-to: 6.2 6.3 Change-Id: I42ade9906e8ba5ebeb1e78cfe3343ac9d89dcada Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Doc: Fix core QML functions signatures and examplesIvan Tkachenko2021-11-021-3/+12
| | | | | | Pick-to: 6.2 Change-Id: I539e54a9a44b65ea9ff50a78c3cfa711860874d4 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Update PropertyChanges in src and toolsUlf Hermann2021-10-291-2/+1
| | | | | | | | | | Use generalized grouped properties rather than the target/property syntax. Change-Id: I2cf42fa7933d67aa40ded5ffd00be51be8f9b7c2 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Maximilian Goldstein <max.goldstein@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Replace 0 pointer constants with nullptrAllan Sandfeld Jensen2021-10-181-1/+1
| | | | | | | Replaced in most common patterns. Change-Id: Idcaff1f2e915f29922702d3600a2e5f1e2418a7a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Fix documentation on JavaScript importsUlf Hermann2021-09-271-1/+2
| | | | | | | | | | Actually export the functions we use, clarify that import and .import are different, and discourage .import. Pick-to: 6.2 5.15 Fixes: QTBUG-96902 Change-Id: I2471d876c83da3d2110add6005d54311d9261566 Reviewed-by: Maximilian Goldstein <max.goldstein@qt.io>
* Adjust import documentation to mention that versions are optionalFabian Kosmale2021-07-211-2/+2
| | | | | | | | | | This change also removes the versions from the import statements. Task-number: QTBUG-95302 Pick-to: 6.1 6.2 Change-Id: Ie29e57a618917977b46dff25d13e3ca3eff249b5 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Use functions as signal handlers when accessing parametersUlf Hermann2021-02-121-3/+3
| | | | | | | | | Injected signal handlers are bad practice because they aren't declared. Pick-to: 6.1 Task-number: QTBUG-89943 Change-Id: I3a691f68342a199bd63034637aa7ed438e3a037b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Remove the qmake project filesFabian Kosmale2021-01-151-22/+0
| | | | | | | | | Remove all qmake project files, except for examples which are used to test that qmake continues to work. Change-Id: Ic4abb72dc2dcd75df7a797c56056b6b3c5fe62ac Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Remove qml statemachine plugin from qtdeclarativeKarsten Heimrich2020-08-2313-1274/+0
| | | | | | Task-number: QTBUG-80316 Change-Id: I584b699a1eec88117f343870bd2cd01075da64f7 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
* Fix file name comment in script.mjs snippetUlf Hermann2020-04-271-1/+1
| | | | | | | | Task-number: QTBUG-83504 Pick-to: 5.15 Change-Id: I4970e929b80f5dae4245404a6db3353f304542ec Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Fix documentation warnings for Qt QMLTopi Reinio2020-02-201-1/+1
| | | | | | Fixes: QTBUG-82313 Change-Id: I7c2f30411ab8011254d7c232c87cb12a39761bda Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Modernize scarceresources snippets and adapt docsUlf Hermann2020-02-113-63/+106
| | | | | | | Also, make sure we can actually compile and test-run the snippets. Change-Id: I50d2bd85528ddbd8d6ad3f38e716b600df54a571 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add inline component documentationFabian Kosmale2020-02-064-0/+267
| | | | | | | Change-Id: Ieff73eba115802722afdbb491b74df5eaad9a4f4 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Pierre-Yves Siret <gr3cko@gmail.com> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Fix documentation warningsTopi Reinio2019-11-112-78/+0
| | | | | | | | | | | | | | | | | | There were a lot of documentation warnings introduced by the separation of QtQml.Models and QtQml.WorkerScript modules from the QtQml documentation project into their own sub-projects. Fix the above, and also ensure that the experimental Qt.labs.qmlmodels QML types are listed in the documentation, and add them also on the QML module page for QtQml.Models. A few warnings remain, they may be indicative of issues not in the scope of this commit. Fixes: QTBUG-79812 Change-Id: Idc25c976e4c96feab4aae893519d6c9245f57a64 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Re-add documentation for Qt Qml ModelsUlf Hermann2019-09-178-846/+0
| | | | | | | It got lost when moving the classes. Change-Id: I7b3a9fec8fe9439c548da570e430d3b82613b816 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Fix docs to explain the new type syntax for QML methodsSimon Hausmann2019-07-105-12/+12
| | | | | | | | | | | | | | [ChangeLog][QtQml] It is now possible to specify types for method parameters and their return value in QML (basic and object types), using TypeScript-like syntax with a colon separator. The syntax for QML declared signals supports the same style. This change also adapts the remaining snippets and docs to the "fresher" qml signal parameter syntax. Change-Id: I601781f01f696276951b04785584adab39fedfd9 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Merge remote-tracking branch 'origin/5.13' into devQt Forward Merge Bot2019-06-111-2/+2
|\ | | | | | | | | | | | | | | | | | | Conflicts: src/qml/jsruntime/qv4value_p.h src/qml/qml/qqmlmetatype.cpp src/qml/qml/qqmltypewrapper.cpp src/quick/items/qquicktableview.cpp Change-Id: I684f8e01a711580512848bf1253f39b39fcbf4c7
| * Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-06-061-2/+2
| |\ | | | | | | | | | Change-Id: I59cb196ab17ed8504b33db01d827052eb6891efa
| | * Doc: Remove superfluous double quotes in code snippetsPaul Wicking2019-06-041-2/+2
| | | | | | | | | | | | | | | | | | Fixes: QTBUG-75957 Change-Id: I2c9c70461a828978d1413b8cbdb407663b4b7493 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | | Add TableModelColumnMitch Curtis2019-04-084-136/+196
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This allows us to support simple object rows by default, which we expect to be the most common use case for TableModel. Complex rows are supported, but with a limited subset of functionality. Things that could be improved: - Would be nice if we could get arbitrary/dynamic properties like ListModel has, without the complex code that comes with it. That way we could get rid of all of the role properties and users could have their own custom roles. The limitation of only having built-in roles becomes too restrictive very quickly. Change-Id: Icbdb6b39665851c55c69c0b79e0aa523c5d46dfe Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* | | Merge remote-tracking branch 'origin/5.13' into devQt Forward Merge Bot2019-03-083-4/+4
|\| | | | | | | | | | | Change-Id: I7aa5284298990062fac9d9f1ab55d05f9b225ac9
| * | Doc: Promote use of ECMAScript modules over Qt.include()Ulf Hermann2019-03-043-4/+4
| |/ | | | | | | | | | | | | | | | | | | | | Also, mention that Qt.include() is deprecated. [ChangeLog][QtQml] Qt.include() is deprecated in favor of ECMAScript modules. Task-number: QTBUG-74068 Change-Id: Ia13e4f1577d86b869a9a1cd810a82ff0b27ea0cc Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* | TableModel: support built-in QML model rolesMitch Curtis2019-02-281-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | For the display role, we'll return the first role in that column if it wasn't explicitly specified. For every other role, we can just return an invalid QVariant. As usual, roleDataProvider can be used for any data that is missing. Before this patch, the extra roles were missing from roleNames, so they couldn't be used in delegates. Change-Id: I53ac5b75526bcddec44baf834f6a093115a70993 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* | TableModel.roleDataProvider: replace row, column with index argumentShawn Rutledge2019-02-221-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | QModelIndex has various advantages over separate int row and column in TableModel API; we intend to expose it via an invokable index() method and via a context property for delegates, and use it in the invokable data() function. So we should be consistent by using it in roleDataProvider too. This way the callback only requires 3 arguments instead of 4, and the first one is potentially extensible, just in case. Change-Id: I7b1bc9ea5adb64941979d83901b3566278357e98 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | TableModel: add roleDataProvider callbackShawn Rutledge2019-02-151-0/+83
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As an alternative to trying to write smarter C++ in the data() accessor, we give the user full control of data conversion by calling an external JS function if defined, to map role to the value that data() should return. This enables extracting arbitrary values, converting the data in arbitrary ways, or even doing calculations in case the EditRole stores a formula and the DisplayRole should provide the result, or something like that. This callback is implemented somewhat like TableView.columnWidthProvider, but the arguments are more complex: function(row, column, role, rawData) Change-Id: Ifaf5807f4809e0b5ad1d1c403f65c0707b902f10 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* | Add TableModelMitch Curtis2019-02-082-0/+239
|/ | | | | | | | | | | | | | | | | | | | | This is a QML type that can be used as a model for the new TableView. The model data is set by assigning a JavaScript array to the rows property (or by calling appendRow()). After data has been assigned for the first time, the available columns and roles are fixed for the lifetime of the model, as opposed to ListModel where the dynamicRoles property could be used. This is done intentionally to simplify the code. The API is designed to be familiar to users of ListModel: - To add new rows, use appendRow() and insertRow(). - To modify existing rows, use setRow(), moveRow(), removeRow(), and clear(). [ChangeLog][Qt Labs QML Models] Added the TableModel QML type, a JavaScript-based model for the new TableView. Fixes: QTBUG-70334 Change-Id: I55387a08b122227c5624f78af3d450b7695d974a Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Use input handlers and controls wherever appropriateVenugopal Shivashankar2018-11-011-5/+4
| | | | | | | | In addition, changed the \section titles to sentence case. Change-Id: If62cc8f2a3f6a99123ccfb4d030d3f58a2fe8dea Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add support for ECMASCript modules in WorkerScript elementsSimon Hausmann2018-08-212-1/+1
| | | | | | | | | Similar to script imports from .qml files, the .mjs extension is used to distinguish between ES modules and plain script files. Change-Id: Id5f9b59fb77e99e3c9d6a404e6d091d96b501ad6 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Fix qdoc files to always use FDLKai Koehne2017-10-181-31/+18
| | | | | Change-Id: If20d71aa85360ad94a2ef12a25ab37cd2d90abf9 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Fix outdated BSD license headerKai Koehne2017-10-1793-266/+1196
| | | | | Change-Id: Icc08925454445fc9497fb3bfd2c26efe90605983 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Add Qt.callLater() function.Michael Brasser2016-03-081-0/+109
| | | | | | | | | | | | | Calling the new Qt.callLater() multiple times in quick succession with the same JS function as argument will result in a single call to that function, thus eliminating redundant unnecessary calls. Based on previous patches by Mathias Malmqvist <mathias.malmqvist@nokia.com> and Chris Adams <chris.adams@jollamobile.com> Change-Id: Ie71b60d4d48fa73d3deae723775cf36662d199ae Task-number: QTBUG-22400 Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>
* Make obj2's text consistent between qtBinding.[23].qmlEdward Welbourne2015-10-161-1/+1
| | | | | | | | The expected text output sides with .3.qml, so fix .2.qml Task-number: QTBUG-48652 Change-Id: I91ac0ab0854df95e06225938d195cd5e3be5abc3 Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
* Doc: resize tables with overflowNico Vertriest2015-06-252-2/+4
| | | | | | Task-number: QTBUG-46475 Change-Id: Iebb2f7677f8b514d2b3e08480abfc98a0e155c1c Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-02 01:39:45 +0000