Doc: Describe adding Studio Components and Effects to Qt installations

The Qt Quick Designer Components module is currently only delivered
with Qt Design Studio. To build projects that use the QML types in
the module, the developer must build the module and install it into
their Qt.

Fixes: QDS-3147
Change-Id: I649576be7f07e19ac2fc3fa9ace6fcb65882ea84
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2020-11-20 17:10:44 +01:00
parent b47d95449d
commit 038cac9fe6

View File

@@ -45,9 +45,13 @@
{devices}
\endlist
You can use a Qt Creator wizard to create a Qt Quick application that is
built using the qmake build system and then copy the source files from the
Qt UI Quick project to the application project.
For more information about integrating QML and C++, see
\l{https://doc.qt.io/qt-5/qtqml-cppintegration-overview.html}
{Overview - QML and C++ Integration}.
You can use a Qt Creator wizard template to create a Qt Quick application
that is built using the qmake build system and then copy the source files
from the Qt UI Quick project to the application project.
You can use the \c RESOURCES option in the project configuration file to
automatically add all the QML files and related assets to a Qt resource
@@ -62,6 +66,10 @@
Then you can use the \l QQuickView class in the main C++ source file to
show the main QML file when the application starts.
The \e {Qt Quick Designer Components} module is delivered with \QDS. If you
use Studio Components or Effects in your project, you have to build the
module and install it to your Qt to be able to build your project.
The \l{Qt Quick Timeline} module is delivered with \QDS and with Qt 5.14,
and later. If you use a timeline in a \QDS project that you import to \QC,
and your Qt is older than 5.14, you must build the Qt Quick Timeline module
@@ -124,6 +132,30 @@
call the QFontDatabase::addApplicationFont() function from the \e {main.cpp}
file.
\section1 Adding Qt Quick Designer Components to Qt Installations
If you use Studio Components or Effects in your project, you have to
check out and install the \e {Qt Quick Designer Components} module from
\l{https://codereview.qt-project.org/admin/repos/qt-labs/qtquickdesigner-components}
{Qt Code Review}.
For example:
\badcode
git clone "ssh://user@codereview.qt-project.org:29418/qt-labs/qtquickdesigner-components"
\endcode
Then use qmake from your Qt installation to build the module and to add it
to your Qt. Switch to the directory that contains the sources (usually,
qtquickdesigner-components), and enter the following commands:
\badcode
<path_to_qmake>\qmake -r
make
make install
\endcode
On Windows, use the \c nmake and \c {nmake install} commands instead.
\section1 Adding Qt Quick Timeline Module to Qt Installations
\note You only need to do this if your Qt version is older than 5.14.
@@ -137,15 +169,6 @@
git clone ssh://user@codereview.qt-project.org:29418/qt/qtquicktimeline
\endcode
Then use qmake from your Qt installation to build the module and to add it
to your Qt. Switch to the directory that contains the sources (usually,
\c qtquicktimeline), and enter the following commands:
\badcode
<path_to_qmake>\qmake -r
make
make install
\endcode
On Windows, use the \c nmake and \c {nmake install} commands instead.
Then build the module and add it to your Qt as described in the previous
section.
*/