Commit Graph

22 Commits

Author SHA1 Message Date
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
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
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
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
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
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