aboutsummaryrefslogtreecommitdiffstats
path: root/doc/snippets
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Remove the "Building UIs with Qt Quick" tree section from qtdocAlexei Cazacov2025-08-0429-1026/+0
| | | | | | | | | | | This commit removes the "Building UIs with Qt Quick" tree section from the qtdoc module. This section is moved to the Qt Quick module as a getting started subtree. Task-number: QTBUG-134130 Pick-to: 6.10 6.9 Change-Id: I818548673460eb940a1ffc898876e986642130f8 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: update reusing qml exampleSemih Yavuz2025-02-201-20/+23
| | | | | | | | | Make UI visible on Qt Creator.Also use id instead of parent. Fixes: QTBUG-107030 Pick-to: 6.8 6.9 Change-Id: Ia856d214d3548e78c3b10a3e0b5e76d143986c7d Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: update QML codestyle guidelines to prefer multi-line styleSemih Yavuz2025-02-191-2/+8
| | | | | | | | | | | | Favor multi-line declarations for qmlformat consistency and readability. Pick-to: 6.9 6.8 6.5 Fixes: QTBUG-116765 Change-Id: If87d121cb7da4082114647b2002d5375f852a4f5 Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Correct doc snippet licenseLucie Gérard2024-04-043-3/+3
| | | | | | | | | | | | | | All files under doc/snippet should be licensed as documentation snippets and according to QUIP-18 [1] this is LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 Task-number: QTBUG-121787 Change-Id: I043e09eea06e18784886676602b54bb3291c39bb Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* codingconventions: Follow current guidelines for example snippetsJoshua Goins2024-01-085-14/+15
| | | | | | | | | | | | Updates the coding convention snippets and example to some of the current QML guidelines, such as: no parenthesis for single arg signal handlers and semicolons in multiline blocks. These rules are also enforced by the qmlformat tool, so it makes sense for the docs to also reflect this. Pick-to: 6.5 6.6 6.7 Change-Id: Iae38d1b32b6550e3f880182d064ee30194e21603 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Plugin documentation: Refer to Document Viewer DemoAxel Spoerl2023-12-204-141/+0
| | | | | | | | | | Update code snippets to use JsonViewer as an example. Add a section about loading plugins. Task-number: QTBUG-119981 Pick-to: 6.7 Change-Id: Ied3dcba02ad275d16535ab015c49ce03ec0a0e30 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* iOS: Update documentation about iconsAlexandru Croitor2023-09-201-0/+104
| | | | | | | | | Pick-to: 6.2 6.5 6.6 Task-number: QTBUG-110921 Task-number: QTBUG-116784 Change-Id: I490054e9aaedc8c6fb742a8c5d4240097186a1f3 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* Examples: Explicitly mention Quick3D requirement in the documentationKai Köhne2023-08-111-0/+3
| | | | | | | | | | | | | Quick3D is an optional component in the online installer. As the examples are part of qtdoc, they are however installed & available also if Quick3D is missing. Let's at least mention the dependency in the respective examples' documentation. Add a general 'Running the Example' section if missing, too. Pick-to: 6.5 6.6 Fixes: QTBUG-114998 Change-Id: If4d3b48b3d0352a0359f6962d4eb1bc2e1e67c95 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Change the license of all CMakeLists.txt and *.cmake files to BSDLucie Gérard2022-08-233-3/+3
| | | | | | | Task-number: QTBUG-105718 Change-Id: Iec124e0bceb4335370674a222970cd9c1b90763f 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-073-0/+9
| | | | | | | | | | | | 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: I9499ba4c20f610ffe8af0fc3e29e6581247f2c40 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-0731-1519/+62
| | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: Idfd176b7f7b077a5b7c66b7738dc9bcac94ab290 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Reorganize work with graphical libraries on INTEGRITYTatiana Borisova2022-04-072-16/+69
| | | | | | | | | | | | - add new paths for GUI pack - delete manual lib packing from instructions Task-number: QTBUG-102268 Pick-to: 6.2 6.3 Change-Id: I87a4e7cb9f1f41f0a805f572c4678cd4fcba121c Reviewed-by: Kimmo Ollila <kimmo.ollila@qt.io> Reviewed-by: Alexey Edelev <alexey.edelev@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* INTEGRITY: update documentation by adding -no_uvfd flag to toolchain fileKimmo Ollila2022-01-252-4/+4
| | | | | | | Pick-to: 6.3 6.2 Change-Id: If4a57029990ff0c68c9385ef8b0691413b59f32b Reviewed-by: Tatiana Borisova <tatiana.borisova@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Doc: Document how to use static plugins with CMakeJoerg Bornemann2022-01-172-3/+22
| | | | | | | | | | | | | | | | | Also, update the existing QTPLUGIN example to import a plugin that is not imported by default. This is closer what one would do in reality. Make the CMake examples match the qmake ones. Move text that describes CMake and qmake to the start of the section, and add a subsection for CMake and qmake each. Pick-to: 6.2 6.3 Fixes: QTBUG-91413 Change-Id: Ie67518dc8757c69f382067a7225c72ff0b512ff8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Alexey Edelev <alexey.edelev@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Add instructions to build Qt6 for INTEGRITY on Windows 10 hostTatiana Borisova2021-12-092-0/+101
| | | | | | | Task-number: QTBUG-96833 Pick-to: 6.2 Change-Id: I44e1c94795a0b0204ad7baac4c53375693fcf26b Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* qmlapp/codingconventions: Recommend using type annotationsMaximilian Goldstein2021-09-011-1/+1
| | | | | | | | | Pick-to: 6.2 Task-number: QTBUG-96150 Change-Id: Iaeaff2558935ca1008fb19416ec4852b6ee51549 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Andrei Golubev <andrei.golubev@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Create Integrity specific documentation for Qt6.2Tatiana Borisova2021-08-241-0/+69
| | | | | | | | | | -Add integrity as a supported platform in the supported platform page Task-number: QTBUG-95422 Pick-to: 6.2 Change-Id: I45c1cf06847ca9aaf85cb7621fd53767cdf37ee8 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* qmlapp/codingconventions: Encourage using named signal parametersMaximilian Goldstein2021-07-291-0/+57
| | | | | | | Pick-to: 6.2 Task-number: QTBUG-92970 Change-Id: I11bf37cae634434a8ad950a902518a9001bf02bb Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* qmlapp/codingconventions: Warn about unqualified accessMaximilian Goldstein2021-07-281-0/+63
| | | | | | | Pick-to: 6.2 Task-number: QTBUG-92970 Change-Id: Ia6c331707f04b02d30fb10b676396eec613cd27a Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* documentation: Do not use versioned QML importKai Koehne2020-12-0222-28/+28
| | | | | | | Pick-to: 6.0 Task-number: QTBUG-89033 Change-Id: I253319dc201d3144860ab344514375a60a7ddb11 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Update QML Applications overview for Qt 6.0Jerome Pasion2020-11-131-0/+73
| | | | | | | | | | | | -Remove content about mobile APIs and multimedia -Add links to other Qt reference and manuals -Add snippet to show basic QML and controls Task-number: QTBUG-87158 Task-number: QTBUG-87744 Change-Id: If320b52f257b1cfb2857d0f2f76262e748473f36 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qmlapp/codingconventions: Treat states and transitions as propertiesMaximilian Goldstein2020-10-221-11/+15
| | | | | | | | | | | | States and transitions are not special on a language level. They should be written along with other object properties. Also updates the example to no longer use the undesirable syntax for Lists. Change-Id: Ib20eb768bd9f6c96b6850cd714f47cda45ce69b9 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Fix "rectange" typoOliver Wolff2020-07-301-1/+1
| | | | | | Pick-to: 5.15 Change-Id: I617b27909349a1cead679a23e93249d8bd1a72c9 Reviewed-by: Rainer Keller <Rainer.Keller@qt.io>
* Remove Lists section from the QML coding conventionsMaximilian Goldstein2020-03-201-72/+0
| | | | | | | | Assigning a single item to a List property without braces makes it ambiguous whether the property is a list or scalar. It should therefore not be encouraged to use this syntax. Change-Id: I1e681ae654b45c830823072a03dca93be674d917 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: Replace Controls 1 and MouseArea referencesVenugopal Shivashankar2018-12-072-10/+50
| | | | | | | | Also, updated the snippet that demonstrates creating custom QML types. Change-Id: I5a385b4d2eb7d96a50f314e5c6d1304665600bb8 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: Replace MouseArea instances with TapHandler in the snippet filesVenugopal Shivashankar2018-10-293-21/+15
| | | | | Change-Id: I27420612cb2a0387684874d797edc159f4485e79 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: Highlight Controls 2 and Input handler types for user inputVenugopal Shivashankar2018-09-252-4/+95
| | | | | | | | | | | In addition, updated a snippet file and added another to complement the text. Task-number: QTBUG-70333 Change-Id: I20e8e13390a00151d040f92d7a54c661e64c17e3 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: give property assignments their own line in coding conventionsMitch Curtis2018-07-161-3/+9
| | | | | | | | | | | | The point of the convention was that related properties should be part of the same "block" or "group" of assignments, which can be achieved by ensuring that they are directly above/below one another. Bunching up assignments onto one line for a few properties should not be a recommended practice. Change-Id: Ie84163b3261e7138d69678e059a91c2c82b43507 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Fix outdated BSD license headerKai Koehne2017-10-171-3/+13
| | | | | Change-Id: I84b17d5d6e19b88943c4e8011fae47060a0abda8 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Doc: edited lines which exceeded 80 positionsNico Vertriest2017-06-121-4/+7
| | | | | Change-Id: I455eb953ee2267d878ca1cab3d36b7da59221e2b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Update QML Coding Conventions to mention semicolon usageMitch Curtis2016-10-061-0/+61
| | | | | | | | | | | | | | The concensus to use semicolons for blocks of code was reached on the mailing list: http://lists.qt-project.org/pipermail/development/2016-October/027441.html Change-Id: I98ce87c623c189bdfac8cfac5c0fa80e5a831c18 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Simon Hausmann <simon.hausmann@qt.io> Reviewed-by: Robin Burchell <robin.burchell@viroteck.net> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Unify license header usageAntti Kokko2016-02-0426-78/+338
| | | | | | | Updated BSD license. Change-Id: Icc360a040f76765d920750f4e590da2717b7041f Reviewed-by: Jani Heikkinen <jani.heikkinen@theqtcompany.com>
* Update copyright headersAntti Kokko2015-02-1727-108/+108
| | | | | | | | | 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: Iedecec76f88fcf709d31bf7bfc5fe817302ecae1 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: corrected link errors qtdocNico Vertriest2015-01-151-1/+2
| | | | | | Change-Id: I557a2f7c71f98457f0c8a1a6c2a6e3a46f975e74 Task-number: QTBUG-43537 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Updated styling QML use case page.Jerome Pasion2014-10-284-227/+20
| | | | | | | | | | -focused on styling the controls -removed section about customizing properties (already covered) -revised the section about SystemPalette Task-number: QTBUG-33595 Change-Id: I065971fa9ab57e5eacf83077925ccb52c9f9717d Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: plugins-howto moved to qtdoc/doc/src/howtosNico Vertriest2014-10-095-0/+350
| | | | | | | Task-number: QTBUG-38412 Change-Id: I15c884ab55796062df204ea30471699910bf2b66 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Bump QtQuick import to 2.3Kai Koehne2014-05-0723-46/+46
| | | | | | | | It doesn't make sense to advocate the use of QtQuick 2.0 anymore. We can expect that people target Qt 5.3 in the Qt 5.3 documentation ... Change-Id: I6ac8dca59a2717fe6d8baec13d968bd74070e90e Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Adding "QML Application Developer Resources" guide.Jerome Pasion2013-04-2928-0/+1904
-ported from qtdeclarative.git -fixed snippet and image paths to doc/snippets and doc/images Because this guide will need to cover more than Qt QML and Qt Quick, this guide does not need to be in qtdeclarative. Change-Id: Id6a47420a1e73b5c55b7233571557e3558e82043 Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-16 23:54:00 +0000