Currently there are two images that serve no purpose in the docs,
as they do not provide any useful information.
This patch removes the following images:
- qml-i18n-example.png
- extending-qml-advanced-word-cloud.png
Fixes: QTBUG-137124
Change-Id: I224fc18eca8a59373fa1b48973816ad826a94625
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
We need to pass a parent to the PieSlices in order to make them visible.
Use inline components to reduce the boiler plate.
Amends commit 775eac90ed
Pick-to: 6.9 6.8
Fixes: QTBUG-135475
Change-Id: I55e2591703ceecbeb883a3f0de2a2a84b1600529
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
If you use QQmlApplicationEngine to auto-load translations you need to
make them visible by placing them inside the relevant QML module.
Pick-to: 6.9 6.8
Fixes: QTBUG-116588
Change-Id: I4b768c6ad6ef763a5d6c43aaa794860f7751398a
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Most people should use the simplest way to instantiate a
QQmlListProperty. Make that clear and add a relevant snippet to the
documentation of the ctor.
Pick-to: 6.9 6.8
Fixes: QTBUG-58643
Change-Id: I6ce07815fe3e74d4b859cc48028e3dd5724fb2ea
Reviewed-by: Alexei Cazacov <alexei.cazacov@qt.io>
Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
This prevents policy warnings in a few cases, and we want people to
opt-in to new policies, so make our examples copy'n'paste friendly.
Pick-to: 6.8
Task-number: QTBUG-126201
Task-number: QTBUG-126468
Change-Id: Iefa666b61c2d2f767da3583f0f6efd8e4a2169e5
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io>
Projects were modified using the tool at:
https://git.qt.io/alcroito/cmake_refactor
A few examples had to be adapted manually, mostly those that build
additional qml modules / plugins.
The INSTALL_EXAMPLESDIR and INSTALL_EXAMPLEDIR assignments were
removed, these are not needed anymore because example directory
selection is handled by the qt_internal_add_example calls.
The install(TARGETS) calls were modified according to our
documentation snippets for qt_generate_deploy_qml_app_script.
A qt_generate_deploy_qml_app_script call was added for each
executable target.
Note that the deployment step will be skipped in the CI for now,
because:
- we enable QT_DEPLOY_MINIMAL_EXAMPLES in the CI instructions and thus
set QT_INTERNAL_SKIP_DEPLOYMENT to true
- standalone examples feature is not yet enabled in the CI, which
means we continue to build examples in-tree, and deployment is
disabled for in-tree prefix builds.
A small list of examples to deploy in the CI will be chosen in the
future, to ensure deployment coverage, without slowing down overall CI
times due to all the *deployqt invocations.
Even if deployment is disabled in the CI, the install(TARGETS) calls
for each example will still run, installing into an
'installed_examples' directory, which will not be archived by the CI.
The QtBundleQmlModuleForMacOS and bundle_shared code was removed,
because we can now depend on the MACOS_BUNDLE_POST_BUILD option of the
deployment api, to ensure macOS bundle examples run properly in the
build dir. This works even in prefix in-tree builds, when installation
deployment is disabled.
Finally, for all examples that build additional qml module libraries or
plugins, the libraries / plugins must be installed into the bin dir of
each project, along with a qmldir file.
This is to support running the installed project for platforms that
don't have deployment api yet, like boot2qt / yocto.
If we want to have super clean install / deployment rules in the
future, we won't be able to avoid adding ugly per-platform conditions.
The current status quo is deemed an improvement over what we had
before.
Pick-to: 6.7
Task-number: QTBUG-101340
Task-number: QTBUG-102056
Task-number: QTBUG-102057
Change-Id: I843d934668c25dbcd1abca52495b393579633fc5
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
Example takes precedent over build system file type.
According to QUIP-18 [1], all examples file should be
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: Ie8c2539e7659f53a1fd6b48f99ee883ee9aeb0a7
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
...according to the Qt 6.7 CMake API review.
Pick-to: 6.7
Task-number: QTBUG-122396
Change-Id: I36d716845d2ce9ed09ed9840f7a1564f59f36977
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
locale example has no documentation
dynamicscene example does not promote good behavior
Task-number: QTBUG-119117
Change-Id: I782375e2ac50b73535d51a031711222efc15b3ad
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
You cannot use the qmldom example without private API, so it is not
really suitable as a public example. Move it to manual tests.
Change-Id: I365b32c1ba1bf4414e439f16ab7df7ae5643d20f
Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io>
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Now that we load the QML file from a different resource directory we
have to adapt the resource paths in qmake, too.
Amends commit 69fce1185f.
Pick-to: 6.6 6.5
Change-Id: I25f3e0f1f77ad365426b859c5adc08b429976da3
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
We shouldn't use NO_RESOURCE_TARGET_PATH. Instead we can put the
translation into the QML module directory. This highlights that
qt_add_qml_module needs an option for adding translations.
Task-number: QTBUG-116588
Task-number: QTBUG-116589
Pick-to: 6.6 6.5
Change-Id: Ib60ec5eedbb395674fdcb9da8fd00ae2663620cc
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Instead of specifying .ts files, we specify languages now.
The i18n/base.ts file is not supposed to be part of the project. It
serves as template for new translations. See the qml-i18n example's
documentation page.
Task-number: QTBUG-117463
Change-Id: I232c1a856e652fc6a31233e7119a1508fba49987
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
Reviewed-by: Serg Kryvonos <serg.kryvonos@qt.io>
Exclude advanced1-Base-project, advanced2-Inheritance-and-coercion and
advanced3-Default-properties, because of missing Qui and Quick
dependencies.
Task-number: QTBUG-111933
Pick-to: 6.5 6.6
Change-Id: Ia472807f9eda3bd6248ff7515d1ca13bc0bde6cf
Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
Outdated documention has been removed.
Task-number: QTBUG-111036
Change-Id: I8db138ff71615a6ed6ac4cebdb365c27252fa5ee
Pick-to: 6.5
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
This allows for more meaningful checks for identical assignment in
Person::setShoe().
Amends: 405bd42998
Pick-to: 6.5
Change-Id: Id731f3f9163fb311ff9b04e2bbf4786a3022a11b
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Use e.g. Qt6::Core instead of Qt::Core. This is better matching the
find_package(Qt6 ...) call, and also avoids issues that the versionless
targets have.
Pick-to: 6.5
Task-number: QTBUG-113277
Change-Id: Ib80f885e9f73fb9ad54b9e9b22cae2318877dc07
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
The examples in the "Extending QML" series were often redundant with the
information of the "Writing QML Extensions with C++" tutorial, had
outdated code and sometimes had no documentation. The examples that
covered topics not mentioned in the first tutorial were revamped into a
second "advanced" tutorial extending the first one. The others were
removed. The remaining examples were largely based on the same example
code of a birthday party. This code was slightly adapted and separated
into 7 states, each building upon the previous, with the code change
illustrating the associated feature. A tutorial page, in the style of
the first one, was added documenting the different QML features and
the required code changes in the example project.
Links in the documentation from and to the affected pages were update
as best as possible.
Pick-to: 6.5
Fixes: QTBUG-111033
Change-Id: I9d97e8b32b128c1624d67525996fa14d493909d3
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
The loadFile overload (in DomItem, DomEnvironment and DomUnivers) for
different files (in-memory files and files that needs to be loaded from
disk) are either copypasted or just calling the other overload.
Encapsulate the file-related arguments of all loadFile overloads into a
new struct called FileToLoad, such that the copypasted overloads can be
removed. Use the static factory function FileToLoad::fromMemory and
FileToLoad::fromFileSystem to create the FileToLoad struct.
In addition, FileToLoad allows to specify the environment in which a
file should be loaded. Prior this commit, myEnv.loadFile() was creating
a new environment for each loaded file.
Change-Id: I3b6acb681cb77faefdaa447d985bdfbe4f6a9ce2
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
We did not document it anywhere, the code is rather dated, and if we
want to promote QML as a scripting engine/an interpreter, we would need
to invest quite a bit more effort into a showcase.
Thus, remove the example for now.
Pick-to: 6.5
Task-number: QTBUG-110649
Change-Id: Ie23b26379e7ea72271d793a6928a3757cde2cb12
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
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>
Instead of linking the example to a standalone build, link it
directly to a normal (=non-standalone) Qt qmldom library.
Link the qmldomloadeditwrite example to the qmldom library (instead of
including the qmldom library as a subfolder in the CMakeLists.txt) and
fix the includes to point to <QtQmlDom/private/<headers>_p.h>.
Change-Id: I6f20ac51199d89b4b3ca03b34e090ac6e495715f
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Every instance of AUTO_RESOURCE_PREFIX has been replaced by either
qt_standard_project_setup(REQUIRES 6.5) or with
qt_policy(SET QTP0001 NEW), mainly in tests.
In addition, I added a warning message for the case where
AUTO_RESOURCE_PREFIX is used.
Pick-to: 6.5
Task-number: QTBUG-96233
Change-Id: I323a15e9d0bb5fe6ba649365314af9fc2ad67bda
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io>
Instead of fetching data from the view, we should rather fetch it from
the model, which avoids a bug with casting when the currentItem is null.
Use the opportunity to use a typed list for the model instead of a plain
JS array.
Original-patch-by: Kai Köhne <kai.koehne@qt.io>
Pick-to: 6.4 6.5
Change-Id: Ib23fb31b3d0a2c309c98bf762cea1a8c05080c38
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
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>
Also, drop all the VERSION 1.0 lines from the examples and tests. 1.0 is
actually a bad default version since it's before all the Qt versions.
[ChangeLog][QML] You can now omit the VERSION argument to
qt_add_qml_module(). This will automatically generate the highest
possible version.
Pick-to: 6.5
Task-number: QTBUG-99146
Change-Id: Ic10ec69b87c224e0e94e1785f65653815d4c778c
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Describe the use of qsTr() and QQmlApplicationEngine, as well
as the CMake qt_add_translations command.
Task-number: QTBUG-110009
Change-Id: I7d2244a772fdb132acdb5f9f66294a7d772e0d36
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
Running qmllint on extending-qml examples raises a plenty of warnings
due to a missing dependency declaration to QtQuick. Simply add it. Also
add FINAL to all properties exposed from C++ to disable (possible) property
shadowings.
Pick-to: 6.4 6.2
Fixes: QTBUG-106602
Change-Id: I7b12a804f8f3ca64bd8f2f312a9e53dfe02b0a4c
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Currently, it's rather hard to find the documentation on how to write
attached properties. The page that gets found first in most search
engines seems to be the example - so link from it to the actual
documentation pages.
Pick-to: 6.2 6.4
Change-Id: I78c9949d62863b5c11ffcd97413084ab03b0bc33
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
We need to deploy qmldir to make the example work also for remote targets.
Pick-to: 6.4 6.3 6.2
Change-Id: Id0b7bf4a48bd163ddf5e44a5a68ca3edbbcc008e
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
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>
Examples that don't explicitly set NO_RESOURCE_TARGET_PATH get the
AUTO_RESOURCE_PREFIX now.
Task-number: QTBUG-103452
Change-Id: I6b41e96ce5620079f60ca2f967b0a2e611c1f738
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
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>
The header file has two snippets with the same id. Rename to unique
values and link to the correct snippet id from the qdoc file.
Fixes: QTWEBSITE-1051
Pick-to: 6.3
Change-Id: I9003916f831898026f520fd86d60ab1c0230e6c4
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
It shouldn't be "dynamicscene" as that URI is already used by a
different example.
Change-Id: I35ac6b7ea70703f24304f640252f922d6a5b2371
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
- Revise grammar
- Fix so that example project can be built from the command line using
CMake
- Add tabs on example page
Pick-to: 6.3
Task-number: QTBUG-102330
Change-Id: Ic6bdcadec66850f5e811dcaac23a8cb59a6c3f94
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Use VERBATIM option to prepare the correct command line for the
add_custom_command. This especially sensitive when using build
directories with names containing special symbols, that cannot be
handled by shell correctly.
Change-Id: Ic6ea2a557fe4e7ccc1d2a0c5c4ab707223c0b91a
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Safiyyah Moosa
Ulf Hermann
Fabian Kosmale
Olivier De Cannière
Alexandru Croitor
Lucie Gérard
Joerg Bornemann
Sami Shalayel
Inkamari Harjula
Elias Hautala
Venugopal Shivashankar
Tor Arne Vestbø
Kai Köhne
Oliver Eftevaag
Amir Masoud Abdol
Leena Miettinen
Topi Reinio
Semih Yavuz
Joni Poikelin
Samuli Piippo
Andreas Eliasson
Fawzi Mohamed
Alexey Edelev