Commit Graph

37 Commits

Author SHA1 Message Date
Semih Yavuz 3eb0f5fc5a Doc: update reusing qml example
Make UI visible on Qt Creator.Also use id instead of parent.

Fixes: QTBUG-107030
Pick-to: 6.8
Change-Id: Ia856d214d3548e78c3b10a3e0b5e76d143986c7d
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
(cherry picked from commit 7630d832ee)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2025-02-21 09:37:16 +00:00
Semih Yavuz 6f2ea69f1f Doc: update QML codestyle guidelines to prefer multi-line style
Favor multi-line declarations for qmlformat consistency and readability.

Pick-to: 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>
(cherry picked from commit a7f88b1893)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2025-02-19 10:10:06 +00:00
Lucie Gérard 5dbcc5f8d6 Correct doc snippet license
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>
2024-04-04 13:43:26 +00:00
Joshua Goins 4994e3dd41 codingconventions: Follow current guidelines for example snippets
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>
2024-01-08 15:14:44 +00:00
Axel Spoerl 0e35a8eaf1 Plugin documentation: Refer to Document Viewer Demo
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>
2023-12-20 11:28:58 +01:00
Alexandru Croitor 00c938441f iOS: Update documentation about icons
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>
2023-09-20 10:26:06 +02:00
Kai Köhne 0f05ed1e01 Examples: Explicitly mention Quick3D requirement in the documentation
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>
2023-08-11 13:58:36 +02:00
Lucie Gérard d490baa159 Change the license of all CMakeLists.txt and *.cmake files to BSD
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>
2022-08-23 10:01:38 +02:00
Lucie Gérard 37540e46fb Add license headers to cmake files
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>
2022-07-07 14:45:33 +02:00
Lucie Gérard 6f57506953 Use SPDX license identifiers
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>
2022-06-07 18:23:52 +02:00
Tatiana Borisova 9ba7a6dbaa Reorganize work with graphical libraries on INTEGRITY
- 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>
2022-04-07 05:37:30 +00:00
Kimmo Ollila d89e68af7a INTEGRITY: update documentation by adding -no_uvfd flag to toolchain file
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>
2022-01-25 09:00:16 +02:00
Joerg Bornemann 456b407825 Doc: Document how to use static plugins with CMake
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>
2022-01-17 17:25:30 +01:00
Tatiana Borisova 88436b8129 Add instructions to build Qt6 for INTEGRITY on Windows 10 host
Task-number: QTBUG-96833
Pick-to: 6.2
Change-Id: I44e1c94795a0b0204ad7baac4c53375693fcf26b
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2021-12-09 14:32:22 +02:00
Maximilian Goldstein 5d32ab4189 qmlapp/codingconventions: Recommend using type annotations
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>
2021-09-01 09:35:37 +02:00
Tatiana Borisova be4dc615ea Create Integrity specific documentation for Qt6.2
-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>
2021-08-24 10:17:52 +03:00
Maximilian Goldstein 0c6f907b27 qmlapp/codingconventions: Encourage using named signal parameters
Pick-to: 6.2
Task-number: QTBUG-92970
Change-Id: I11bf37cae634434a8ad950a902518a9001bf02bb
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-07-29 09:20:36 +02:00
Maximilian Goldstein b20d38b6e1 qmlapp/codingconventions: Warn about unqualified access
Pick-to: 6.2
Task-number: QTBUG-92970
Change-Id: Ia6c331707f04b02d30fb10b676396eec613cd27a
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2021-07-28 14:35:49 +02:00
Kai Koehne e896196f39 documentation: Do not use versioned QML import
Pick-to: 6.0
Task-number: QTBUG-89033
Change-Id: I253319dc201d3144860ab344514375a60a7ddb11
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-12-02 09:14:29 +01:00
Jerome Pasion 4f94ab4e3b Update QML Applications overview for Qt 6.0
-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>
2020-11-13 10:24:19 +01:00
Maximilian Goldstein 90cb1091b3 qmlapp/codingconventions: Treat states and transitions as properties
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>
2020-10-22 15:24:13 +02:00
Oliver Wolff 7dbaed07d4 Fix "rectange" typo
Pick-to: 5.15
Change-Id: I617b27909349a1cead679a23e93249d8bd1a72c9
Reviewed-by: Rainer Keller <Rainer.Keller@qt.io>
2020-07-30 13:45:32 +02:00
Maximilian Goldstein 5c1956d122 Remove Lists section from the QML coding conventions
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>
2020-03-20 15:20:37 +01:00
Venugopal Shivashankar 9d88932795 Doc: Replace Controls 1 and MouseArea references
Also, updated the snippet that demonstrates creating
custom QML types.

Change-Id: I5a385b4d2eb7d96a50f314e5c6d1304665600bb8
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2018-12-07 12:55:55 +00:00
Venugopal Shivashankar 11e2c7e480 Doc: Replace MouseArea instances with TapHandler in the snippet files
Change-Id: I27420612cb2a0387684874d797edc159f4485e79
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2018-10-29 12:54:00 +00:00
Venugopal Shivashankar fe91a75b3e Doc: Highlight Controls 2 and Input handler types for user input
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>
2018-09-25 09:58:04 +00:00
Mitch Curtis d336ca0186 Doc: give property assignments their own line in coding conventions
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>
2018-07-16 09:33:06 +00:00
Kai Koehne e1d555955d Fix outdated BSD license header
Change-Id: I84b17d5d6e19b88943c4e8011fae47060a0abda8
Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
2017-10-17 12:41:29 +00:00
Nico Vertriest 51522bb943 Doc: edited lines which exceeded 80 positions
Change-Id: I455eb953ee2267d878ca1cab3d36b7da59221e2b
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-06-12 12:11:07 +00:00
Mitch Curtis 2c2150c613 Update QML Coding Conventions to mention semicolon usage
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>
2016-10-06 11:40:48 +00:00
Antti Kokko 0112781936 Unify license header usage
Updated BSD license.

Change-Id: Icc360a040f76765d920750f4e590da2717b7041f
Reviewed-by: Jani Heikkinen <jani.heikkinen@theqtcompany.com>
2016-02-04 09:40:20 +00:00
Antti Kokko ebd19207b9 Update copyright headers
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>
2015-02-17 10:18:46 +00:00
Nico Vertriest f2b0ed69b0 Doc: corrected link errors qtdoc
Change-Id: I557a2f7c71f98457f0c8a1a6c2a6e3a46f975e74
Task-number: QTBUG-43537
Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-01-15 14:06:33 +01:00
Jerome Pasion 60dad7d411 Doc: Updated styling QML use case page.
-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>
2014-10-28 19:32:29 +01:00
Nico Vertriest 5052da3d02 Doc: plugins-howto moved to qtdoc/doc/src/howtos
Task-number: QTBUG-38412
Change-Id: I15c884ab55796062df204ea30471699910bf2b66
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-10-09 10:46:25 +02:00
Kai Koehne 0cd4e38612 Bump QtQuick import to 2.3
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>
2014-05-07 08:38:25 +02:00
Jerome Pasion 8c8b826d62 Doc: Adding "QML Application Developer Resources" guide.
-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>
2013-04-29 14:32:59 +02:00