diff options
| author | Tim Jenssen <tim.jenssen@qt.io> | 2020-05-27 19:02:07 +0200 |
|---|---|---|
| committer | Tim Jenssen <tim.jenssen@qt.io> | 2020-05-27 19:02:07 +0200 |
| commit | 5b0040185085704ea284cc7fdb6a95603caca203 (patch) | |
| tree | 383315424e4595b1ecde6476c39f4fff50396602 /doc | |
| parent | 8c9aea6f11b6dee68fa8f16b7e791acd4d342ebe (diff) | |
| parent | b193892fd1289bd8a995cd609ead33f925b75ee1 (diff) | |
Merge remote-tracking branch 'origin/qds-1.50' into qds-1.59
Change-Id: If4869664ad4cbb5ec56e7c306f47d0bf0f1f075c
Diffstat (limited to 'doc')
118 files changed, 529 insertions, 441 deletions
diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf index c71ddf7fa2..88a92778d6 100644 --- a/doc/config/macros.qdocconf +++ b/doc/config/macros.qdocconf @@ -17,6 +17,9 @@ macro.note = "\\b{Note:}" macro.oslash.HTML = "ø" macro.ouml.HTML = "ö" macro.QA = "Qt Assistant" +macro.QB = "Qt Bridge" +macro.QBPS = "Qt Bridge for Adobe Photoshop" +macro.QBSK = "Qt Bridge for Sketch" macro.QC = "$IDE_DISPLAY_NAME" macro.QCE = "$IDE_DISPLAY_NAME Enterprise" macro.QD = "Qt Designer" diff --git a/doc/images/qtcreator-kit-nimble.png b/doc/images/qtcreator-kit-nimble.png Binary files differdeleted file mode 100644 index fd21928ef9..0000000000 --- a/doc/images/qtcreator-kit-nimble.png +++ /dev/null diff --git a/doc/images/qtcreator-project-nimble.png b/doc/images/qtcreator-project-nimble.png Binary files differdeleted file mode 100644 index ae928bebc2..0000000000 --- a/doc/images/qtcreator-project-nimble.png +++ /dev/null diff --git a/doc/images/qtcreator-python-wizard-qml.png b/doc/images/qtcreator-python-wizard-qml.png Binary files differdeleted file mode 100644 index d8d3aeb929..0000000000 --- a/doc/images/qtcreator-python-wizard-qml.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_advanceduse.png b/doc/qtcreator/images/creator_advanceduse.png Binary files differdeleted file mode 100644 index c3ec46c38e..0000000000 --- a/doc/qtcreator/images/creator_advanceduse.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_buildingrunning.png b/doc/qtcreator/images/creator_buildingrunning.png Binary files differdeleted file mode 100644 index a52c4b392f..0000000000 --- a/doc/qtcreator/images/creator_buildingrunning.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_coding.png b/doc/qtcreator/images/creator_coding.png Binary files differdeleted file mode 100644 index 9597fe831f..0000000000 --- a/doc/qtcreator/images/creator_coding.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_designinguserinterface.png b/doc/qtcreator/images/creator_designinguserinterface.png Binary files differdeleted file mode 100644 index 85162a52ce..0000000000 --- a/doc/qtcreator/images/creator_designinguserinterface.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_gettinghelp.png b/doc/qtcreator/images/creator_gettinghelp.png Binary files differdeleted file mode 100644 index c3ae18b392..0000000000 --- a/doc/qtcreator/images/creator_gettinghelp.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_gettingstarted.png b/doc/qtcreator/images/creator_gettingstarted.png Binary files differdeleted file mode 100644 index e6177959ad..0000000000 --- a/doc/qtcreator/images/creator_gettingstarted.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_managingprojects.png b/doc/qtcreator/images/creator_managingprojects.png Binary files differdeleted file mode 100644 index dfb2ebe67d..0000000000 --- a/doc/qtcreator/images/creator_managingprojects.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_publishing.png b/doc/qtcreator/images/creator_publishing.png Binary files differdeleted file mode 100644 index b7e79a9bc3..0000000000 --- a/doc/qtcreator/images/creator_publishing.png +++ /dev/null diff --git a/doc/qtcreator/images/creator_testing.png b/doc/qtcreator/images/creator_testing.png Binary files differdeleted file mode 100644 index 395f898cdd..0000000000 --- a/doc/qtcreator/images/creator_testing.png +++ /dev/null diff --git a/doc/qtcreator/images/front-advanced.png b/doc/qtcreator/images/front-advanced.png Binary files differnew file mode 100644 index 0000000000..67e0ef2ad9 --- /dev/null +++ b/doc/qtcreator/images/front-advanced.png diff --git a/doc/qtcreator/images/front-coding.png b/doc/qtcreator/images/front-coding.png Binary files differnew file mode 100644 index 0000000000..da5cf5f3b6 --- /dev/null +++ b/doc/qtcreator/images/front-coding.png diff --git a/doc/qtcreator/images/front-gs.png b/doc/qtcreator/images/front-gs.png Binary files differnew file mode 100644 index 0000000000..16c0483535 --- /dev/null +++ b/doc/qtcreator/images/front-gs.png diff --git a/doc/qtcreator/images/front-help.png b/doc/qtcreator/images/front-help.png Binary files differnew file mode 100644 index 0000000000..9eb11f716a --- /dev/null +++ b/doc/qtcreator/images/front-help.png diff --git a/doc/qtcreator/images/front-preview.png b/doc/qtcreator/images/front-preview.png Binary files differnew file mode 100644 index 0000000000..fc57868e11 --- /dev/null +++ b/doc/qtcreator/images/front-preview.png diff --git a/doc/qtcreator/images/front-projects.png b/doc/qtcreator/images/front-projects.png Binary files differnew file mode 100644 index 0000000000..8ea1a82954 --- /dev/null +++ b/doc/qtcreator/images/front-projects.png diff --git a/doc/qtcreator/images/front-publishing.png b/doc/qtcreator/images/front-publishing.png Binary files differnew file mode 100644 index 0000000000..cd142df588 --- /dev/null +++ b/doc/qtcreator/images/front-publishing.png diff --git a/doc/qtcreator/images/front-testing.png b/doc/qtcreator/images/front-testing.png Binary files differnew file mode 100644 index 0000000000..79f80f750a --- /dev/null +++ b/doc/qtcreator/images/front-testing.png diff --git a/doc/qtcreator/images/front-ui.png b/doc/qtcreator/images/front-ui.png Binary files differnew file mode 100644 index 0000000000..3613a65676 --- /dev/null +++ b/doc/qtcreator/images/front-ui.png diff --git a/doc/qtcreator/images/qmldesigner-bindings.png b/doc/qtcreator/images/qmldesigner-bindings.png Binary files differindex c3a90cc3c7..017b22cd23 100644 --- a/doc/qtcreator/images/qmldesigner-bindings.png +++ b/doc/qtcreator/images/qmldesigner-bindings.png diff --git a/doc/qtcreator/images/qmldesigner-editing-components.png b/doc/qtcreator/images/qmldesigner-editing-components.png Binary files differnew file mode 100644 index 0000000000..1fe80e23c1 --- /dev/null +++ b/doc/qtcreator/images/qmldesigner-editing-components.png diff --git a/doc/qtcreator/images/qmldesigner-element-properties.png b/doc/qtcreator/images/qmldesigner-element-properties.png Binary files differindex 6df75cc67a..18239bdf41 100644 --- a/doc/qtcreator/images/qmldesigner-element-properties.png +++ b/doc/qtcreator/images/qmldesigner-element-properties.png diff --git a/doc/qtcreator/images/qmldesigner-properties-view.png b/doc/qtcreator/images/qmldesigner-properties-view.png Binary files differnew file mode 100644 index 0000000000..36c2e9ca15 --- /dev/null +++ b/doc/qtcreator/images/qmldesigner-properties-view.png diff --git a/doc/qtcreator/images/qmldesigner-qml-components.png b/doc/qtcreator/images/qmldesigner-qml-components.png Binary files differindex a2b090dd37..46918eee92 100644 --- a/doc/qtcreator/images/qmldesigner-qml-components.png +++ b/doc/qtcreator/images/qmldesigner-qml-components.png diff --git a/doc/qtcreator/images/qmldesigner-screen-design.png b/doc/qtcreator/images/qmldesigner-screen-design.png Binary files differindex 42bb30bb16..ff19977a0f 100644 --- a/doc/qtcreator/images/qmldesigner-screen-design.png +++ b/doc/qtcreator/images/qmldesigner-screen-design.png diff --git a/doc/qtcreator/images/qmldesigner-states-when-condition.png b/doc/qtcreator/images/qmldesigner-states-when-condition.png Binary files differindex a26ba37b52..7a1530efb0 100644 --- a/doc/qtcreator/images/qmldesigner-states-when-condition.png +++ b/doc/qtcreator/images/qmldesigner-states-when-condition.png diff --git a/doc/qtcreator/images/qmldesigner-states.png b/doc/qtcreator/images/qmldesigner-states.png Binary files differindex 0b2510e6dc..4f1193bfba 100644 --- a/doc/qtcreator/images/qmldesigner-states.png +++ b/doc/qtcreator/images/qmldesigner-states.png diff --git a/doc/qtcreator/images/qmldesigner-transitions.png b/doc/qtcreator/images/qmldesigner-transitions.png Binary files differindex 8d7309ddc8..8791133a87 100644 --- a/doc/qtcreator/images/qmldesigner-transitions.png +++ b/doc/qtcreator/images/qmldesigner-transitions.png diff --git a/doc/qtcreator/src/analyze/cpu-usage-analyzer.qdoc b/doc/qtcreator/src/analyze/cpu-usage-analyzer.qdoc index c32e8854b0..2e931ee049 100644 --- a/doc/qtcreator/src/analyze/cpu-usage-analyzer.qdoc +++ b/doc/qtcreator/src/analyze/cpu-usage-analyzer.qdoc @@ -460,7 +460,7 @@ \list 1 \li Perf events may be globally disabled on your system. The - preconfigured Boot to Qt images come with perf events enabled. For + preconfigured Boot2Qt images come with perf events enabled. For a custom configuration you need to make sure that the file \c {/proc/sys/kernel/perf_event_paranoid} contains a value smaller than \c {2}. For maximum flexibility in recording traces you can diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc b/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc index a9c53ea4e2..abef5908c8 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc @@ -32,7 +32,7 @@ /*! //! [cmake deploying embedded] - \section1 Deploying CMake Projects to Embedded Linux Devices + \section1 Deploying CMake Projects to Generic Remote Linux Devices \QC cannot directly extract files to be installed from a CMake project. Therefore, a special deploy step is created that installs the project into diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc index e5f61c7caf..d4779653c3 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc @@ -158,6 +158,6 @@ \li \l {Opening Projects} \li \l {Specifying Build Settings} \li \l {Specifying Run Settings} - \li \l {Deploying CMake Projects to Embedded Linux Devices} + \li \l {Deploying CMake Projects to Generic Remote Linux Devices} \endlist */ diff --git a/doc/qtcreator/src/editors/creator-coding.qdoc b/doc/qtcreator/src/editors/creator-coding.qdoc index 5250c351b6..a8b86f6b58 100644 --- a/doc/qtcreator/src/editors/creator-coding.qdoc +++ b/doc/qtcreator/src/editors/creator-coding.qdoc @@ -41,7 +41,7 @@ \title Coding \if defined(qtcreator) - \image creator_coding.png + \image front-coding.png \endif \list diff --git a/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc b/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc index 7eeb4f6820..a7efe0ba1a 100644 --- a/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc +++ b/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc @@ -38,11 +38,11 @@ \nextpage creator-deployment-qnx.html \endif - \title Deploying Applications to Embedded Linux Devices + \title Deploying Applications to Generic Remote Linux Devices - You can specify settings for deploying applications to generic Linux devices - in the project .pro file. You can view the settings in the - \uicontrol Projects mode, in \uicontrol {Run Settings}. + You can specify settings for deploying applications to generic remote + Linux devices in the project .pro file. You can view the settings in + the \uicontrol Projects mode, in \uicontrol {Run Settings}. \image qtcreator-embedded-linux-deployment-overview.png "Deploy to device" diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc b/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc index f573a0de79..a744b6e9e9 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc @@ -26,14 +26,14 @@ /*! //! [running on embedded linux] - \section1 Running on Embedded Linux Devices + \section1 Running on Generic Remote Linux Devices To build the application and run it on a device: \list 1 \li Specify a connection to the device. For more information, see - \l{Connecting Embedded Linux Devices}. + \l{Connecting Generic Remote Linux Devices}. \li Click the \uicontrol Run button. diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc index ea34ff83de..5a7edda0f5 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -24,11 +24,11 @@ ****************************************************************************/ /*! -//! [run settings embedded] +//! [run settings boot2qt] - \section1 Specifying Run Settings for Embedded Devices + \section1 Specifying Run Settings for Boot2Qt Devices - To run and debug an application on an embedded device (commercial only), you + To run and debug an application on a Boot2Qt device (commercial only), you must create connections from the development host to the device and add the device configurations to \l{glossary-buildandrun-kit}{kits}. Select \uicontrol {Manage Kits} to add devices to kits. For more information, see @@ -41,7 +41,7 @@ host and on the device. For more information on the deployment steps, see - \l{Deploying Applications to Embedded Linux Devices}. + \l{Deploying Applications to Generic Remote Linux Devices}. -//! [run settings embedded] +//! [run settings boot2qt] */ diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc index 1d64706acf..4cb407f630 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc @@ -33,7 +33,7 @@ host to the device and add the device configurations to \l{glossary-buildandrun-kit}{kits}. Click \uicontrol {Manage Kits} to add devices to kits. For more information, see - \l {Connecting Embedded Linux Devices}. + \l {Connecting Generic Remote Linux Devices}. When you run the application, \QC copies the files to the connected device. diff --git a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc index da7e6cca08..e726841c0a 100644 --- a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc +++ b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -33,19 +33,20 @@ \nextpage creator-developing-ios.html \endif - \title Connecting Embedded Linux Devices + \title Connecting Generic Remote Linux Devices - You can connect embedded Linux devices to the development PC to run, + You can connect generic Linux devices to the development PC to run, debug, and analyze applications built for them from \QC. If you have a tool chain for building applications for embedded Linux devices installed on the development PC, you can add it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit} with \uicontrol {Embedded Linux} device type to - build applications for and run them on embedded Linux devices. + build applications for and run them on the devices. - To be able to run and debug applications on embedded Linux devices, you must - add devices and select them in the \QC \l{glossary-buildandrun-kit}{kit}. + To be able to run and debug applications on generic remote Linux devices, + you must add devices and select them in the \QC \l{glossary-buildandrun-kit} + {kit}. You use a wizard to create the connections. You can edit the settings later in \uicontrol Tools > \uicontrol Options > \uicontrol Devices > @@ -145,7 +146,7 @@ When you run the project, \QC deploys the application as specified by the deploy steps. By default, \QC copies the application files to the device. - For more information, see \l{Deploying Applications to Embedded Linux Devices}. + For more information, see \l{Deploying Applications to Generic Remote Linux Devices}. \endlist diff --git a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc index 362425971a..7f89c0ea81 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc @@ -36,7 +36,7 @@ \title Advanced Use - \image creator_advanceduse.png + \image front-advanced.png \QC attempts to meet your development needs, whether you are an experienced Qt developer or a newcomer to Qt. When you install \QC diff --git a/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc index 21903f7ad5..f1d40a058d 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc @@ -49,7 +49,7 @@ When you deploy the application to an Android device, \QC copies the application files to the device. In addition, you can determine the Qt libraries to use. - \li \l{Deploying Applications to Embedded Linux Devices} + \li \l{Deploying Applications to Generic Remote Linux Devices} When you deploy the application to a generic Linux-based device, \QC copies the application files to the connected device. You can test diff --git a/doc/qtcreator/src/overview/creator-only/creator-design-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-design-overview.qdoc index 456df09ff7..67dbd629af 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-design-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-design-overview.qdoc @@ -36,7 +36,7 @@ \title Designing User Interfaces - \image creator_designinguserinterface.png + \image front-ui.png \QC provides integrated visual editors for designing Qt Quick and widget-based applications in the Design mode. The integration diff --git a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc index 627bd49595..4efb8f79dd 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc @@ -38,9 +38,9 @@ \table \row - \li \inlineimage creator_gettingstarted.png - \li \inlineimage creator_designinguserinterface.png - \li \inlineimage creator_advanceduse.png + \li \inlineimage front-gs.png + \li \inlineimage front-ui.png + \li \inlineimage front-advanced.png \row \li \b {\l{IDE Overview}} @@ -59,8 +59,8 @@ control systems. For an overview of the options you have, go to \l{Configuring Qt Creator}. \row - \li \inlineimage creator_buildingrunning.png - \li \inlineimage creator_gettinghelp.png + \li \inlineimage front-preview.png + \li \inlineimage front-help.png \li \row \li \b {\l{Building and Running an Example}} diff --git a/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc index 5ce2e861b0..b808d79e53 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc @@ -36,7 +36,7 @@ \title Getting Help - \image creator_gettinghelp.png + \image front-help.png \list diff --git a/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc b/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc index 97daacfd62..659a837567 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc @@ -69,7 +69,7 @@ to debug applications on them with GDB or a hardware debugger. \endif - \li \l{Connecting Embedded Linux Devices} + \li \l{Connecting Generic Remote Linux Devices} If you have a tool chain for building applications for embedded Linux devices installed on the development @@ -114,7 +114,7 @@ You can use the experimental Qt Application Manager plugin (commercial only) to deploy, run, and debug applications on the local Linux PC, remote generic SSH Linux targets, or - \l{Embedded Devices}{embedded devices}. + \l{Boot2Qt Devices}{Boot2Qt devices}. \endlist \endif */ diff --git a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc index 1ba098e4ee..98415f3760 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc @@ -47,9 +47,9 @@ \table \row - \li \inlineimage creator_managingprojects.png - \li \inlineimage creator_designinguserinterface.png - \li \inlineimage creator_coding.png + \li \inlineimage front-projects.png + \li \inlineimage front-ui.png + \li \inlineimage front-coding.png \row \li \b {\l{Managing Projects}} @@ -84,9 +84,9 @@ available that provides information about the code to IDEs. For more information, see \l{Coding}. \row - \li \inlineimage creator_buildingrunning.png - \li \inlineimage creator_testing.png - \li \inlineimage creator_publishing.png + \li \inlineimage front-preview.png + \li \inlineimage front-testing.png + \li \inlineimage front-publishing.png \row \li \b {\l{Building and Running}} diff --git a/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc b/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc index 7013ee6cea..ce8f01a5b5 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc @@ -112,7 +112,7 @@ \endlist - \section2 Developing for Embedded Devices + \section2 Developing for Boot2Qt Devices Either Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS or later is required to install and use Qt for Device Creation. For more information diff --git a/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc b/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc index 91a8193fea..04c2fd936f 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc +++ b/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -31,30 +31,21 @@ You can develop applications for the following platforms: \list - \li Desktop - - \li Android - - \li Embedded - - \li Generic remote Linux - - \li iOS - - \li Microcontroller Units (MCU) - - \li QNX - - \li Universal Windows Platform (UWP) - - \li WebAssembly - + \li \l{Connecting Android Devices}{Android} + \li \l{Connecting Bare Metal Devices}{Bare Metal} + \li Boot2Qt + \li \l{Connecting Generic Remote Linux Devices}{Generic Remote Linux} + \li \l{Connecting iOS Devices}{iOS} + \li \l{Connecting MCUs}{Microcontroller Units (MCU)} (commercial only) + \li \l{Connecting QNX Devices}{QNX} + \li \l{Qt for UWP}{Universal Windows Platform (UWP)} + \li \l{Building Applications for the Web}{WebAssembly} \endlist - \section2 Embedded Devices + \section2 Boot2Qt Devices - The Boot to Qt stack can be made to run on a variety of hardware. For + The Boot2Qt stack can be made to run on a variety of hardware. For Qt for Device Creation license holders, tooling is provided to customize the contents of the stack as well as to take it into desired production hardware. @@ -65,8 +56,8 @@ \l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation} documentation. - \note Since \QC 4.9, only Boot to Qt version 5.9 and later are supported. - To develop for earlier Boot to Qt versions, use \QC 4.8. + \note Since \QC 4.9, only Boot2Qt version 5.9 and later are supported. + To develop for earlier Boot2Qt versions, use \QC 4.8. \section2 Mobile Devices @@ -99,8 +90,8 @@ \li \row \li MCUs - \li \image ok - \li \image ok + \li + \li \li \image ok \row \li QNX diff --git a/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc b/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc index c446fb82f7..cab7e02ee4 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-testing.qdoc @@ -36,7 +36,7 @@ \title Testing - \image creator_testing.png + \image front-testing.png \list diff --git a/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc b/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc index 2e69569f68..912863c18e 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc @@ -36,7 +36,7 @@ \title Tutorials - \image creator_gettinghelp.png + \image front-help.png You can use \QC to create applications for several platforms by using several technologies. The tutorials in this manual explain how to create diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc index c536c91cdd..1e2960eca0 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc @@ -43,7 +43,7 @@ the development environment for Android or iOS. For more information, see \l{Connecting Android Devices} and \l{Connecting iOS Devices}. - To run an example application on an embedded device, you must set up + To run an example application on a Boot2Qt device, you must set up Qt for Device Creation on the development host and create connections between the host and devices. For more information, see the \l{http://doc.qt.io/QtForDeviceCreation/qtee-installation-guide.html} @@ -66,7 +66,7 @@ You can also use tags (3) to filter examples. For instance, enter the \uicontrol Boot2Qt tag (commercial only) in the search field - (4) to list examples that you can run on embedded devices. + (4) to list examples that you can run on Boot2Qt devices. \li To check that the application code can be compiled and linked for a device, click the \uicontrol {Kit Selector} and select a diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc index d132bf4410..c98362ae17 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc @@ -36,7 +36,7 @@ \title Building and Running - \image creator_buildingrunning.png + \image front-preview.png \QC provides support for running and deploying Qt applications built for different target platforms, or using different compilers, debuggers, or diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc index 0866481120..2ff19db916 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc @@ -102,18 +102,18 @@ \list \li Qt Quick Application - Empty - Create an empty Qt Quick application that uses Qt Quick 2 types. + Create an empty \l{Qt Quick} application that uses Qt Quick 2 + types. You can build the application and deploy it to desktop, embedded, and mobile target platforms. \li Qt Quick Application - Scroll, Stack, or Swipe - Create a Qt Quick application that uses - \l{http://doc.qt.io/qt-5/qtquickcontrols2-index.html} - {Qt Quick Controls} to implement a scrollable list (requires - Qt 5.9 or later) or a set of pages with a stack-based or - swipe-based navigation model (requires Qt 5.7 or later). + Create a Qt Quick application that uses \l{Qt Quick Controls} to + implement a scrollable list (requires Qt 5.9 or later) or a set + of pages with a stack-based or swipe-based navigation model + (requires Qt 5.7 or later). \endlist \li Application (Qt) @@ -150,8 +150,8 @@ \list \li MCU Support Application - Creates an application that uses a subset of QML and - Qt Quick Controls (as supported by Qt for MCUs) that + Creates an application that uses a subset of Qt QML and + Qt Quick Controls types (as supported by Qt for MCUs) that you can deploy, run, and debug on MCU boards. For more information, see \l {Connecting MCUs}. \endlist diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc index 4a2c4c42ab..df454aaa6d 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc @@ -141,10 +141,11 @@ \section1 Providing Deployment Information - If you want to run your application on an embedded Linux device, you first need to - deploy your executable and possibly other files. \QC does that for you - automatically if you provide the necessary information. This works the same - way as explained for CMake \l {Deploying CMake Projects to Embedded Linux Devices}{here}, + If you want to run your application on a generic remote Linux device, + you first need to deploy your executable and possibly other files. + \QC does that for you automatically if you provide the necessary + information. This works the same way as explained for CMake + \l {Deploying CMake Projects to Generic Remote Linux Devices}{here}, except that you also need to include your application binary in the list. \section1 Creating a Run Configuration diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc index 53a3f11667..f2534ba8d8 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc @@ -36,7 +36,7 @@ \title Managing Projects - \image creator_managingprojects.png + \image front-projects.png One of the major advantages of \QC is that it allows a team of designers and developers to share a project across different development platforms with a diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc index 2591640a6d..3b564ee283 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc @@ -84,7 +84,7 @@ \include creator-projects-settings-run-android.qdocinc run settings android \include creator-projects-settings-run-linux.qdocinc run settings linux \include creator-projects-settings-run-qnx.qdocinc run settings qnx - \include linux-mobile/creator-projects-settings-run-b2qt.qdocinc run settings embedded + \include linux-mobile/creator-projects-settings-run-b2qt.qdocinc run settings boot2qt \section1 Selecting the Run Environment diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc index e31a3d568a..caa3d94082 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -47,29 +47,20 @@ devices: \list - - \li Android Device - - \li Bare Metal Device - - \li Boot2Qt Device (commercial only) - - \li \l {Emulator}{Boot2Qt Emulator Device} (commercial only) - - \li Generic Linux Device - - \li iOS Device - + \li \l{Connecting Android Devices}{Android Device} + \li \l{Connecting Bare Metal Devices}{Bare Metal Device} + \li \l{https://doc.qt.io/QtForDeviceCreation/b2qt-installation-guides.html} + {Boot2Qt Device} (commercial only) + \li \l{Emulator}{Boot2Qt Emulator Device} (commercial only) + \li \l{Connecting Generic Remote Linux Devices}{Generic Remote Linux Device} + \li \l{Connecting iOS Devices}{iOS Device} \li iOS Simulator - - \li QNX Device - - \li Windows Phone - + \li \l{Connecting MCUs}{MCU Device} (commercial only) + \li \l{Connecting QNX Devices}{QNX Device} + \li \l{Building Applications for the Web}{WebAssembly Runtime} + \li \l{Qt for UWP}{Windows Phone} \li Windows Phone Emulator - \li Windows Runtime (local) - \endlist \section1 Filtering Kit Settings diff --git a/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc b/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc index 19e1217e63..232a371e26 100644 --- a/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc +++ b/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc @@ -41,7 +41,7 @@ \title Deploying Applications to QNX Neutrino Devices You can deploy applications to QNX Neutrino devices in the way that is - described in \l{Deploying Applications to Embedded Linux Devices}. + described in \l{Deploying Applications to Generic Remote Linux Devices}. \image qtcreator-qnx-deployment.png "Deploy to device" diff --git a/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc b/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc index e535c04e04..6af72ab253 100644 --- a/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc +++ b/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc @@ -42,8 +42,9 @@ \section1 Adding a QNX Neutrino Device in \QC - Adding a QNX Neutrino device is very similar to \l{Connecting Embedded - Linux Devices}, except you need to select \uicontrol {QNX Device} in the + Adding a QNX Neutrino device is very similar to + \l{Connecting Generic Remote Linux Devices}, except that + you need to select \uicontrol {QNX Device} in the \uicontrol {Device Configuration} wizard. \section1 Adding Kits for QNX Devices diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index da35dae588..021b7052f8 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -127,7 +127,7 @@ \endlist \li \l{Importing 3D Assets} \li \l{Editing 3D Assets in Design Mode} - \li \l{Working in the 3D Editor} + \li \l{Working in 3D Editor} \li \l{Adding 3D Views} \li \l{Using 3D Components} \list @@ -196,14 +196,14 @@ \li \l{Deploying to Devices} \list \li \l{Deploying Applications to Android Devices} - \li \l{Deploying Applications to Embedded Linux Devices} + \li \l{Deploying Applications to Generic Remote Linux Devices} \li \l{Deploying Applications to QNX Neutrino Devices} \endlist \li \l{Connecting Devices} \list \li \l{Connecting Android Devices} \li \l{Connecting Bare Metal Devices} - \li \l{Connecting Embedded Linux Devices} + \li \l{Connecting Generic Remote Linux Devices} \li \l{Connecting iOS Devices} \li \l{Connecting MCUs} \li \l{Connecting QNX Devices} diff --git a/doc/qtcreator/src/qtcreator.qdoc b/doc/qtcreator/src/qtcreator.qdoc index fe5e7f8175..71d2a2a1fe 100644 --- a/doc/qtcreator/src/qtcreator.qdoc +++ b/doc/qtcreator/src/qtcreator.qdoc @@ -54,10 +54,10 @@ \table \row - \li \inlineimage creator_gettingstarted.png - \li \inlineimage creator_managingprojects.png - \li \inlineimage creator_designinguserinterface.png - \li \inlineimage creator_coding.png + \li \inlineimage front-gs.png + \li \inlineimage front-projects.png + \li \inlineimage front-ui.png + \li \inlineimage front-coding.png \row \li \b {\l{Getting Started}} \list @@ -90,10 +90,10 @@ \li \l{Editing State Charts} \endlist \row - \li \inlineimage creator_buildingrunning.png - \li \inlineimage creator_testing.png - \li \inlineimage creator_advanceduse.png - \li \inlineimage creator_gettinghelp.png + \li \inlineimage front-preview.png + \li \inlineimage front-testing.png + \li \inlineimage front-advanced.png + \li \inlineimage front-help.png \row \li \b {\l{Building and Running}} \list diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-states-scxml.qdocinc b/doc/qtcreator/src/qtquick/creator-only/qtquick-states-scxml.qdocinc index ccbc236229..18100dfe36 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-states-scxml.qdocinc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-states-scxml.qdocinc @@ -26,20 +26,23 @@ /*! //! [scxml state machines] - \section2 Using SCXML State Machines + \section1 Using SCXML State Machines - To use QML together with an SCXML state machine, add states and bind them to - the state machine in the \uicontrol Backends tab in the Design mode, as + To use QML together with an SCXML state machine, add states and + bind them to the state machine in the \uicontrol Backends tab + of the \uicontrol Connections view, as described in \l {Managing C++ Backend Objects}. - In the \uicontrol States view, you can edit the \c when condition of states + In the \uicontrol States view, you can select \uicontrol Actions > + \uicontrol {Set when Condition} to edit the \c when condition of states to map QML states to the states of the SCXML state machine. For an example, see \l {Qt SCXML Traffic Light QML Example (Dynamic)}. \image qmldesigner-states-when-condition.png - If you add animation to the states, you can run the application to test the - animation. + If you add animation to the states, you can \l{Previewing}{preview} + or \l{Running on Multiple Platforms}{run} the application to test + the animation. //! [scxml state machines] */ diff --git a/doc/qtcreator/src/qtquick/qtquick-components.qdoc b/doc/qtcreator/src/qtquick/qtquick-components.qdoc index 3820b01116..ca4a6e6d89 100644 --- a/doc/qtcreator/src/qtquick/qtquick-components.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-components.qdoc @@ -51,14 +51,15 @@ \image qmldesigner-qml-components.png "QML Components" - The \uicontrol {QML Types} tab displays the QML types grouped by category: - your own QML components, basic types, layouts, positioner types, and views. + The \uicontrol {QML Types} tab displays the QML types grouped by category, + such as your own QML components, basic types, layouts, positioner types, and + views. Sets of UI components with the look and feel of a particular mobile device platform have been defined for Qt Quick 1. Since Qt 5.1, ready-made Qt Quick Controls, Dialogs, and Layouts are available for creating user interfaces using Qt Quick 2. The components and controls are based on - standard QML types. To view the components and controls in the + standard QML types. To view the components and controls in \uicontrol {Library}, import the component sets in \uicontrol {QML Imports}. The \uicontrol {Qt Quick Application} wizards for a particular platform add @@ -70,21 +71,23 @@ \section1 Adding Components to Designs - \image studio-design-mode.png "Design mode" + \image qmldesigner-editing-components.png "Editing QML components in Design mode" \list 1 - \li Drag and drop components from the \uicontrol Library (2) to the - \uicontrol Navigator (3) or \uicontrol {Form Editor} (1). - \li Select components in the \uicontrol Navigator to edit their - properties in the \uicontrol Properties view (4). For more - information, see \l {Specifying Item Properties}. + \li Drag and drop components from \uicontrol Library (1) to + \uicontrol Navigator (2) or \uicontrol {Form Editor} (3). + \li Select components in \uicontrol Navigator to edit their + properties in \uicontrol Properties. + \image qmldesigner-properties-view.png "Properties view" + For more information, see \l {Specifying Item Properties}. \li Connect components to signals or create bindings between components - in the \uicontrol Connections view (5). For more information, see - \l{Adding Connections}. + in the \uicontrol Connections view. + \image qmldesigner-bindings.png "Connections view Bindings tab" + For more information, see \l{Adding Connections}. \li Add states to apply sets of changes to the properties of one or - several components in the \uicontrol States view (6). For more - information, see \l{Adding States}. - \li Animate component properties in the \uicontrol Timeline view (7). + several components in the \uicontrol States view. + For more information, see \l{Adding States}. + \li Animate component properties in the \uicontrol Timeline view. For more information, see \l{Creating Animations}. \endlist @@ -136,12 +139,12 @@ When you add a \l{GridView}{Grid View}, \l{ListView}{List View}, or \l{PathView}{Path View}, the ListModel and the delegate component that creates an instance for each item in the model are added automatically. - You can edit item properties in the \uicontrol Properties view or - in the \uicontrol {Text Editor}. You can also replace the default model and - delegate with other, more complex models and delegates in the + You can edit item properties in \uicontrol Properties or in + \uicontrol {Text Editor}. You can also replace the default model and + delegate with other, more complex models and delegates in \uicontrol {Text Editor}. \l{ItemDelegate}{Item Delegate} and \l{SwipeDelegate}{Swipe Delegate} delegate components are also available - in the \uicontrol Library. + in \uicontrol Library. \section1 Positioning Items in UIs @@ -179,7 +182,7 @@ \image qmldesigner-set-expression.png "Type properties context menu" - In the \uicontrol {Binding Editor}, select an item and a property from + In \uicontrol {Binding Editor}, select an item and a property from lists of available items and their properties. \image qmldesigner-binding-editor.png "Binding Editor" @@ -192,7 +195,7 @@ When a binding is set, the \uicontrol Actions menu icon changes to \inlineimage icons/action-icon-binding - . To remove bindings, select \uicontrol Reset in the \uicontrol Actions menu. + . To remove bindings, select \uicontrol Actions > \uicontrol Reset. You can set bindings also in the \uicontrol Connections view. For more information, see \l {Adding Bindings Between Properties}. @@ -227,7 +230,7 @@ (\uicontrol {Reset Anchors}) button to reset the anchors to their saved state. - You can specify the baseline anchor in the \uicontrol {Text Editor} in the + You can specify the baseline anchor in \uicontrol {Text Editor} in the Design mode. For performance reasons, you can only anchor an item to its siblings @@ -340,8 +343,9 @@ \endlist To position several items in a \uicontrol Column, \uicontrol Row, - \uicontrol Grid, or \uicontrol Flow, select the items on the canvas, and - then select \uicontrol Position in the context menu. + \uicontrol Grid, or \uicontrol Flow, select the items in + \uicontrol {Form Editor}, and then select \uicontrol Position in + the context menu. \section2 Using Layouts @@ -353,8 +357,6 @@ You can use the following layout types to arrange items in UIs: \list - \li \l{Layout} provides attached properties for items pushed onto a - column, row, or grid layout. \li \l{ColumnLayout}{Column Layout} provides a grid layout with only one column. \li \l{RowLayout}{Row Layout} provides a grid layout with only one row. @@ -365,7 +367,7 @@ \endlist To lay out several items in a column, row, grid, or - \uicontrol {Stack Layout}, select the items in the \uicontrol {Form Editor}, + \uicontrol {Stack Layout}, select the items in \uicontrol {Form Editor}, and then select \uicontrol Layout in the context menu. You can also click the \inlineimage column.png @@ -374,9 +376,9 @@ (\uicontrol {Grid Layout}) toolbar buttons to apply layouts to the selected items. - To make an item within a layout as wide as possible while respecting - the given constraints, select the item on the canvas and then select - \uicontrol Layout > \uicontrol {Fill Width} in the context menu. To + To make an item within a layout as wide as possible while respecting the + given constraints, select the item in \uicontrol {Form Editor}, and then + select \uicontrol Layout > \uicontrol {Fill Width} in the context menu. To make the item as high as possible, select \uicontrol {Fill Height}. \section2 Editing Stack Layouts @@ -385,7 +387,7 @@ To add items to a \uicontrol {Stack Layout}, select the \inlineimage plus.png - button next to the type name in the \uicontrol {Form Editor}. To move + button next to the type name in \uicontrol {Form Editor}. To move between items, select the \inlineimage prev.png (\uicontrol Previous) and \inlineimage next.png (\uicontrol Next) buttons. @@ -550,22 +552,22 @@ \endif \uicontrol Choose to create a new .qml file. - \note Components are listed in the \uicontrol {QML Components} section of - the \uicontrol Library only if the filename begins with a capital - letter. + \note Components are listed in the \uicontrol {My QML Components} + tab in the \uicontrol Library view only if the filename begins with + a capital letter. \li Click \uicontrol Design to open the .qml file in the Design mode. - \li Drag and drop a QML type from the \uicontrol Library to the + \li Drag and drop a QML type from \uicontrol Library to \uicontrol Navigator or \uicontrol {Form Editor}. - \li Edit its properties in the \uicontrol Properties view. + \li Edit its properties in \uicontrol Properties. The available properties depend on the QML type. \endlist - The following sections contain more information about how to use the + The following sections contain more information about how to use \uicontrol {Form Editor} to edit 2D content, as well as examples of how to create some common components using basic QML types: @@ -582,10 +584,11 @@ \section1 Moving Within Components Components can consist of several other components. To view the component - hierarchy as a bread crumb path when you edit a component on the canvas, - select \uicontrol {Go into Component} or press \key F2. Click the component - names in the path to navigate to them. You can easily navigate back to the - top level when you are done editing the component. + hierarchy as a bread crumb path when you edit a component in + \uicontrol {Form Editor}, select \uicontrol {Go into Component} or press + \key F2. Click the component names in the path to navigate to them. You + can easily navigate back to the top level when you are done editing the + component. \image qmldesigner-breadcrumbs.png "Go into Component command" */ diff --git a/doc/qtcreator/src/qtquick/qtquick-connection-editor.qdoc b/doc/qtcreator/src/qtquick/qtquick-connection-editor.qdoc index 5c8cba4870..395327e1bc 100644 --- a/doc/qtcreator/src/qtquick/qtquick-connection-editor.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-connection-editor.qdoc @@ -50,7 +50,7 @@ until it is explicitly assigned a new value. However, to make the fullest use of QML and its built-in support for dynamic object behaviors, most QML types use property bindings. This means that you can specify relationships - between different object properties so that when a property's sependencies + between different object properties so that when a property's dependencies change in value, the property's value is automatically updated accordingly. Behind the scenes, the QML engine monitors the property's dependencies (that diff --git a/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc b/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc index 8cf7f9303f..0bf837ee8c 100644 --- a/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -34,7 +34,7 @@ To preview UIs on Android devices, you need to enable USB debugging on them and connect them to your system with a USB cable. \endomit - To preview UIs on embedded devices, you need to connect the devices to your + To preview UIs on Boot2Qt devices, you need to connect the devices to your system with a USB cable, or a wired or wireless connection, depending on the device, and configure connections to them. The necessary kits have been predefined and you only need to enable them for your current project. @@ -79,9 +79,9 @@ device. \endomit - \section2 Previewing on Embedded Devices + \section2 Previewing on Boot2Qt Devices - You can preview UIs on embedded devices that are supported by + You can preview UIs on Boot2Qt devices that are supported by \l{Qt for Device Creation}. For a list of supported devices, see \l{https://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html#reference-target-devices} {Reference Target Devices}. diff --git a/doc/qtcreator/src/qtquick/qtquick-properties.qdoc b/doc/qtcreator/src/qtquick/qtquick-properties.qdoc index cdba49811c..78c70b2809 100644 --- a/doc/qtcreator/src/qtquick/qtquick-properties.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-properties.qdoc @@ -37,7 +37,7 @@ The bottom part of the view displays properties that are specific to each QML type. For example, the following image displays the properties you can - set for \uicontrol Rectangle (1) and \uicontrol Text (2) items. + set for \uicontrol Rectangle and \uicontrol Text items. \image qmldesigner-element-properties.png diff --git a/doc/qtcreator/src/qtquick/qtquick-states.qdoc b/doc/qtcreator/src/qtquick/qtquick-states.qdoc index d670fb21b5..d3902d34d6 100644 --- a/doc/qtcreator/src/qtquick/qtquick-states.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-states.qdoc @@ -55,56 +55,59 @@ \list \li Show some UI items and hide others. \li Present different available actions to the user. - \li Start, stop or pause animations. + \li Start, stop, or pause animations. \li Execute some script required in the new state. \li Change a property value for a particular item. \li Show a different view. \endlist + \section1 Creating States + The \uicontrol States view displays the different \l{State}{states} - of the component in the Design mode. The \uicontrol States view is - collapsed by default to save space. Select \uicontrol Expand in - the context menu to view the whole view. + of a UI, beginning with a \e {base state}. \image qmldesigner-transitions.png "States view" To add states, click the \inlineimage plus.png - button. Then modify the new state in the editor. For example, to change the - appearance of a button, you can hide the button image and show another image - in its place. Or, to add movement to the view, you can change the position - of an object on the canvas and then add animation to the change between the - states. - - To determine when the state should be applied, select - \uicontrol {Set when Condition} in the menu and specify a - \l [QtQuick]{State::when}{when} property for the state. - Set the value of the property to an expression that - evaluates to \c true when you want the state to be applied. - In the binding editor, select the component and property to - create the expression. For example, to change the state when - a button is pressed, you could select a button component and - its pressed property. - - \image qtquick-states-binding-editor.png "Binding editor in States view" - - You can preview the states in the \uicontrol States view and click them to - switch between states on the canvas. + button. Click the new state to switch to it in \uicontrol {Form Editor}, + and then modify the properties of components in \uicontrol Properties. - \section1 Using States + For example, to change the appearance of a button, you can hide the button + image and show another image in its place. Or, to add movement to the view, + you can change the position of an object in \uicontrol {Form Editor} + and then add animation to the change between the states. + + The properties that you change in a state are highlighted with blue color. + In \uicontrol {Text Editor}, you can see the changes recorded as changes + to the base state. - QML states typically describe user interface configurations, such as the UI - controls, their properties and behavior and the available actions. For - example, you can use states to create two views. + \image qmldesigner-states.png "States and Properties views" - To add states, click the empty slot in the \uicontrol States view. - Then modify the new state in the \uicontrol {Form Editor} or the - \uicontrol Properties view. + \section1 Setting the Default State - \image qmldesigner-states.png "States view" + To determine the startup state of the application, + select \inlineimage icons/action-icon.png + to open the \uicontrol Actions menu, and then select + \uicontrol {Set as Default}. - The properties that you change in a state are highlighted with blue color. - In the \uicontrol {Text Editor}, you can see the changes recorded as changes - to the base state. + To reset the state later, select \uicontrol Actions > + \uicontrol {Reset Default}. + + \section1 Applying States + + To determine when a state should be applied, select \uicontrol Actions > + \uicontrol {Set when Condition}. In \uicontrol {Binding Editor}, specify + a \l [QtQuick]{State::when}{when} property for the state. Set the value of + the property to an expression that evaluates to \c true when you want the + state to be applied. + + In \uicontrol {Binding Editor}, select the component and property to + create the expression. For example, to change the state when a button is + pressed, you could select a button component and its pressed property. + + \image qtquick-states-binding-editor.png "Binding Editor in States view" + + \section1 Using States To keep the QML code clean, you should create a base state that contains all the types you will need in the application. You can then create states, @@ -124,30 +127,24 @@ To create views for an application by using states: + \image qmldesigner-screen-design.png "Designing views" + \list 1 \li In the base state, add all items you will need in the application (1). While you work on one view, you can click the \inlineimage eye_open.png icon to hide items on the canvas that are not part of a view. - \li In the \uicontrol States view, click the empty slot to create a + \li In \uicontrol States, click the empty slot to create a new state and give it a name. For example, \c Normal. - \li In the \uicontrol Properties view (2), deselect the - \uicontrol Visibility check box or set \uicontrol Opacity to 0 - for each item that is not needed in this view. If you specify - the setting for the parent item, all child items inherit it and - are also hidden. - \image qmldesigner-screen-design.png "Designing views" + \li In \uicontrol Properties (2), deselect the \uicontrol Visibility + check box or set \uicontrol Opacity to 0 for each item that is not + needed in this view. If you specify the setting for the parent item, + all child items inherit it and are also hidden. \li Create additional states for each view and set the visibility or opacity of the items in the view. - \li To determine which view opens when the application starts, use the - \uicontrol {Text Editor} to set the state of the root item of the - .qml file, as specified by the following code snippet: - \qml - Item { - state: "Normal" - } - \endqml - \endlist + \li To determine which state is applied when the application starts, + select \uicontrol Actions > \uicontrol {Set as Default}. + \endlist \if defined(qtcreator) \include qtquick-states-scxml.qdocinc scxml state machines @@ -165,7 +162,7 @@ the type of behavior that is required. You can drag and drop the following QML types from \uicontrol Library - > \uicontrol {QML Types} > \uicontrol {Qt Quick - Animation} to the + > \uicontrol {QML Types} > \uicontrol {Qt Quick - Animation} to \uicontrol Navigator or \uicontrol {Form Editor}: \list @@ -181,10 +178,10 @@ sequential animation to create a step where nothing happens, for a specified duration. \li \l [QML] {PropertyAction}{Property Action} immediately changes - a propertyvalue during an animation, without animating the property - change. + a property value during an animation, without animating the + property change. \li \l [QML] {PropertyAnimation}{Property Animation} animates - changes in thevalue of a property. + changes in the value of a property. \li \l [QML] {ScriptAction}{Script Action} defines scripts to be run during an animation. \li \l [QML] {SequentialAnimation}{Sequential Animation} enables diff --git a/doc/qtdesignstudio/config/qtdesignstudio.qdocconf b/doc/qtdesignstudio/config/qtdesignstudio.qdocconf index 1fcda6e66a..d99c57c609 100644 --- a/doc/qtdesignstudio/config/qtdesignstudio.qdocconf +++ b/doc/qtdesignstudio/config/qtdesignstudio.qdocconf @@ -110,10 +110,6 @@ qhp.qtdesignstudio.subprojects.manual.type = manual # Doxygen compatibility commands macro.see = "\\sa" macro.function = "\\fn" -macro.QB = "Qt Bridge" -macro.QBPS = "Qt Bridge for Adobe Photoshop" -macro.QBSK = "Qt Bridge for Sketch" -macro.QDS = "Qt Design Studio" navigation.landingpage = "$IDE_DISPLAY_NAME Manual" buildversion = "$IDE_DISPLAY_NAME Manual $QTC_VERSION" diff --git a/doc/qtdesignstudio/examples/clustertutorial/ClusterTutorial.qmlproject b/doc/qtdesignstudio/examples/ClusterTutorial/ClusterTutorial.qmlproject index 94dd80cfdc..94dd80cfdc 100644 --- a/doc/qtdesignstudio/examples/clustertutorial/ClusterTutorial.qmlproject +++ b/doc/qtdesignstudio/examples/ClusterTutorial/ClusterTutorial.qmlproject diff --git a/doc/qtdesignstudio/examples/coffeemachine/ApplicationFlow.qml b/doc/qtdesignstudio/examples/CoffeeMachine/ApplicationFlow.qml index eaeffa83e7..eaeffa83e7 100644 --- a/doc/qtdesignstudio/examples/coffeemachine/ApplicationFlow.qml +++ b/doc/qtdesignstudio/examples/CoffeeMachine/ApplicationFlow.qml diff --git a/doc/qtdesignstudio/examples/coffeemachine/CoffeeButton.qml b/doc/qtdesignstudio/examples/CoffeeMachine/CoffeeButton.qml index d2d9e85873..d2d9e85873 100644 --- a/doc/qtdesignstudio/examples/coffeemachine/CoffeeButton.qml +++ b/doc/qtdesignstudio/examples/CoffeeMachine/CoffeeButton.qml diff --git a/doc/qtdesignstudio/examples/coffeemachine/CoffeeMachine.qmlproject b/doc/qtdesignstudio/examples/CoffeeMachine/CoffeeMachine.qmlproject index 8a2ecfb6af..8a2ecfb6af 100644 --- a/doc/qtdesignstudio/examples/coffeemachine/CoffeeMachine.qmlproject +++ b/doc/qtdesignstudio/examples/CoffeeMachine/CoffeeMachine.qmlproject diff --git a/doc/qtdesignstudio/examples/coffeemachine/SideBar.qml b/doc/qtdesignstudio/examples/CoffeeMachine/SideBar.qml index 241f78fc47..241f78fc47 100644 --- a/doc/qtdesignstudio/examples/coffeemachine/SideBar.qml +++ b/doc/qtdesignstudio/examples/CoffeeMachine/SideBar.qml diff --git a/doc/qtdesignstudio/examples/ebikedesign/EBikeDesign.qmlproject b/doc/qtdesignstudio/examples/EBikeDesign/EBikeDesign.qmlproject index 0165571771..0165571771 100644 --- a/doc/qtdesignstudio/examples/ebikedesign/EBikeDesign.qmlproject +++ b/doc/qtdesignstudio/examples/EBikeDesign/EBikeDesign.qmlproject diff --git a/doc/qtdesignstudio/examples/sidemenu/CustomButton.qml b/doc/qtdesignstudio/examples/SideMenu/CustomButton.qml index 9f140b69a2..9f140b69a2 100644 --- a/doc/qtdesignstudio/examples/sidemenu/CustomButton.qml +++ b/doc/qtdesignstudio/examples/SideMenu/CustomButton.qml diff --git a/doc/qtdesignstudio/examples/sidemenu/SideMenu.qml b/doc/qtdesignstudio/examples/SideMenu/SideMenu.qml index 4649d497e6..4649d497e6 100644 --- a/doc/qtdesignstudio/examples/sidemenu/SideMenu.qml +++ b/doc/qtdesignstudio/examples/SideMenu/SideMenu.qml diff --git a/doc/qtdesignstudio/examples/sidemenu/SideMenu.qmlproject b/doc/qtdesignstudio/examples/SideMenu/SideMenu.qmlproject index 22969ff4d8..22969ff4d8 100644 --- a/doc/qtdesignstudio/examples/sidemenu/SideMenu.qmlproject +++ b/doc/qtdesignstudio/examples/SideMenu/SideMenu.qmlproject diff --git a/doc/qtdesignstudio/examples/webinardemo/WebinarDemo.qmlproject b/doc/qtdesignstudio/examples/WebinarDemo/WebinarDemo.qmlproject index 5a19a305ab..5a19a305ab 100644 --- a/doc/qtdesignstudio/examples/webinardemo/WebinarDemo.qmlproject +++ b/doc/qtdesignstudio/examples/WebinarDemo/WebinarDemo.qmlproject diff --git a/doc/qtdesignstudio/examples/doc/loginui4.qdoc b/doc/qtdesignstudio/examples/doc/loginui4.qdoc index e9e19eaeb9..95f8d5819e 100644 --- a/doc/qtdesignstudio/examples/doc/loginui4.qdoc +++ b/doc/qtdesignstudio/examples/doc/loginui4.qdoc @@ -32,7 +32,6 @@ \brief Illustrates how to use the timeline and states to animate UI components. \previouspage {Log In UI - Part 3} - \nextpage {Log In UI - Part 5} \image loginui4.gif "Log In UI" diff --git a/doc/qtdesignstudio/examples/doc/progressbar.qdoc b/doc/qtdesignstudio/examples/doc/progressbar.qdoc index 208e97bf8d..0dfb333e41 100644 --- a/doc/qtdesignstudio/examples/doc/progressbar.qdoc +++ b/doc/qtdesignstudio/examples/doc/progressbar.qdoc @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \example ProgressBar + \example progressbar \ingroup studioexamples \title Progress Bar diff --git a/doc/qtdesignstudio/images/area-light.png b/doc/qtdesignstudio/images/area-light.png Binary files differdeleted file mode 100644 index 89d4c31dfa..0000000000 --- a/doc/qtdesignstudio/images/area-light.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/directional-light.png b/doc/qtdesignstudio/images/directional-light.png Binary files differdeleted file mode 100644 index cf7a1214cb..0000000000 --- a/doc/qtdesignstudio/images/directional-light.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/qt-sketch-bridge-library.png b/doc/qtdesignstudio/images/qt-sketch-bridge-library.png Binary files differnew file mode 100644 index 0000000000..b65a094820 --- /dev/null +++ b/doc/qtdesignstudio/images/qt-sketch-bridge-library.png diff --git a/doc/qtdesignstudio/images/studio-3d-area-light.png b/doc/qtdesignstudio/images/studio-3d-area-light.png Binary files differnew file mode 100644 index 0000000000..d31661e992 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-area-light.png diff --git a/doc/qtdesignstudio/images/studio-3d-directional-light.png b/doc/qtdesignstudio/images/studio-3d-directional-light.png Binary files differindex f5e16e8e40..e43f6ec541 100644 --- a/doc/qtdesignstudio/images/studio-3d-directional-light.png +++ b/doc/qtdesignstudio/images/studio-3d-directional-light.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.png b/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.png Binary files differnew file mode 100644 index 0000000000..edaaeea4ef --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-editor-axis-helper.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-move.png b/doc/qtdesignstudio/images/studio-3d-editor-move.png Binary files differindex 77e83eacd5..5163aa78c6 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-move.png +++ b/doc/qtdesignstudio/images/studio-3d-editor-move.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-rotate.png b/doc/qtdesignstudio/images/studio-3d-editor-rotate.png Binary files differindex 033c4c4a9e..5f7c13d4e5 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-rotate.png +++ b/doc/qtdesignstudio/images/studio-3d-editor-rotate.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor-scale.png b/doc/qtdesignstudio/images/studio-3d-editor-scale.png Binary files differindex af2ecee0d0..8ae936f175 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor-scale.png +++ b/doc/qtdesignstudio/images/studio-3d-editor-scale.png diff --git a/doc/qtdesignstudio/images/studio-3d-editor.png b/doc/qtdesignstudio/images/studio-3d-editor.png Binary files differindex 575b7510c6..00c55df87f 100644 --- a/doc/qtdesignstudio/images/studio-3d-editor.png +++ b/doc/qtdesignstudio/images/studio-3d-editor.png diff --git a/doc/qtdesignstudio/images/studio-3d-point-light.png b/doc/qtdesignstudio/images/studio-3d-point-light.png Binary files differindex 9252f47c78..ac3b7f51f9 100644 --- a/doc/qtdesignstudio/images/studio-3d-point-light.png +++ b/doc/qtdesignstudio/images/studio-3d-point-light.png diff --git a/doc/qtdesignstudio/images/studio-3d-scenes.png b/doc/qtdesignstudio/images/studio-3d-scenes.png Binary files differindex 94dbb54778..0dc2121f73 100644 --- a/doc/qtdesignstudio/images/studio-3d-scenes.png +++ b/doc/qtdesignstudio/images/studio-3d-scenes.png diff --git a/doc/qtdesignstudio/images/studio-3d-spot-light.png b/doc/qtdesignstudio/images/studio-3d-spot-light.png Binary files differnew file mode 100644 index 0000000000..cc678a801d --- /dev/null +++ b/doc/qtdesignstudio/images/studio-3d-spot-light.png diff --git a/doc/qtdesignstudio/images/studio-animation.png b/doc/qtdesignstudio/images/studio-animation.png Binary files differindex 1bcabc0a13..1365c2df96 100644 --- a/doc/qtdesignstudio/images/studio-animation.png +++ b/doc/qtdesignstudio/images/studio-animation.png diff --git a/doc/qtdesignstudio/images/studio-animation.svg b/doc/qtdesignstudio/images/studio-animation.svg new file mode 100644 index 0000000000..7e4e93b0f2 --- /dev/null +++ b/doc/qtdesignstudio/images/studio-animation.svg @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 24.1.2, SVG Export Plug-In . SVG Version: 6.00 Build 0) --> +<svg version="1.1" baseProfile="tiny" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" + x="0px" y="0px" viewBox="0 0 450 270" overflow="visible" xml:space="preserve"> +<g> + <g> + <path fill="#C9C7C7" d="M433.8,269.6H16.2c-7.8,0-14.2-6.4-14.2-14.2V14.2C2,6.4,8.4,0,16.2,0h417.6c7.8,0,14.2,6.4,14.2,14.2 + v241.2C448,263.2,441.6,269.6,433.8,269.6z"/> + <path fill="#878686" d="M2.4,19.5L2,14.1C2,6.3,8.3,0,16.1,0h417.9c7.8,0,14.1,6.3,14.1,14.1v6.8"/> + <circle fill="#DD5858" cx="19.3" cy="10.6" r="5"/> + <circle fill="#DBC558" cx="36.1" cy="10.6" r="5"/> + <circle fill="#52B257" cx="52.9" cy="10.6" r="5"/> + </g> + <path fill="#FFFFFF" d="M437.1,262.2H13.4c-2.8,0-5-2.2-5-5V185c0-2.8,2.2-5,5-5h423.7c2.8,0,5,2.2,5,5v72.2 + C442.1,260,439.9,262.2,437.1,262.2z"/> + <path fill="none" stroke="#FFFFFF" stroke-width="7.4167" stroke-linecap="round" stroke-miterlimit="10" d="M190.6,91.4 + c0-24.3,19.7-44.1,44.1-44.1s44.1,19.7,44.1,44.1s-19.7,44.1-44.1,44.1"/> + <circle fill="#FFFFFF" cx="233.8" cy="91.1" r="19.7"/> + <polygon fill="#878686" points="258.9,158 256.2,193.9 267.4,180.3 284.4,183.1 "/> + <path fill="#878686" d="M228.2,195.9H19.4c-2.8,0-5-2.2-5-5V188c0-2.8,2.2-5,5-5h208.8c2.8,0,5,2.2,5,5v2.9 + C233.2,193.6,231,195.9,228.2,195.9z"/> + <path fill="#878686" d="M348,223.6H206.5c-2.8,0-5-2.2-5-5v-2.9c0-2.8,2.2-5,5-5H348c2.8,0,5,2.2,5,5v2.9 + C353,221.4,350.8,223.6,348,223.6z"/> + <path fill="#878686" d="M419.3,247.4h-86.1c-2.8,0-5-2.2-5-5v-2.9c0-2.8,2.2-5,5-5h86.1c2.8,0,5,2.2,5,5v2.9 + C424.3,245.1,422.1,247.4,419.3,247.4z"/> + + <rect x="222.4" y="199" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -77.0099 218.9356)" fill="#878686" width="6.8" height="6.8"/> + + <rect x="18.4" y="199" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -136.7589 74.6888)" fill="#878686" width="6.8" height="6.8"/> + + <rect x="117.4" y="199" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -107.7546 144.7115)" fill="#878686" width="6.8" height="6.8"/> + + <rect x="210.5" y="226.7" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -100.0968 218.6541)" fill="#878686" width="6.8" height="6.8"/> + + <rect x="307.5" y="226.7" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -71.6725 287.2764)" fill="#878686" width="6.8" height="6.8"/> + + <rect x="338.2" y="251.5" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -80.1869 316.2345)" fill="#878686" width="6.8" height="6.8"/> + + <rect x="410.5" y="251.5" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -59.0137 367.3511)" fill="#878686" width="6.8" height="6.8"/> + <g> + <path fill="#FFFFFF" d="M175.7,73.5v14h-2.9V76.8l-3,1.9l-1.3-2.2l4.6-3.1H175.7z"/> + </g> + <g> + <path fill="#FFFFFF" d="M290.4,59.2h-9.1v-2.5l3-3c1.1-1.1,1.8-1.9,2.2-2.5s0.6-1.2,0.6-1.9c0-0.7-0.2-1.1-0.5-1.4 + c-0.3-0.3-0.8-0.4-1.5-0.4c-0.9,0-2,0.1-3.1,0.3l-0.5,0.1l-0.1-2.3c1.4-0.4,2.8-0.6,4.3-0.6c3,0,4.4,1.3,4.4,4 + c0,1-0.2,1.9-0.7,2.7s-1.3,1.7-2.5,2.8l-2.4,2.2h5.8V59.2z"/> + </g> + <g> + <path fill="#8389A8" d="M238.9,145.1c1.6-0.6,3.5-1,5.5-1c2,0,3.5,0.4,4.4,1.2s1.4,2,1.4,3.7c0,1.7-0.7,3-2.1,3.9 + c0.9,0.5,1.5,0.9,1.8,1.4s0.5,1.3,0.5,2.4c0,1.9-0.5,3.3-1.4,4.3c-1,0.9-2.5,1.4-4.6,1.4c-1.6,0-3.2-0.2-4.9-0.7l-0.9-0.2l0.2-2.8 + c2,0.3,3.7,0.5,5,0.5c1.8,0,2.8-0.8,2.8-2.4c0-0.7-0.2-1.2-0.7-1.6c-0.5-0.4-1.1-0.6-1.9-0.6h-3.6v-3h3.6c0.6,0,1.1-0.2,1.6-0.7 + c0.5-0.5,0.7-1.1,0.7-1.7c0-1.3-0.9-1.9-2.6-1.9c-1.2,0-2.5,0.1-3.9,0.4l-0.7,0.1L238.9,145.1z"/> + </g> + <line fill="none" stroke="#F9D953" stroke-width="3" stroke-miterlimit="10" x1="103.5" y1="269.2" x2="103.5" y2="165.2"/> + <polygon fill="#F9D953" points="103.4,178.2 111.2,164.7 95.6,164.7 "/> +</g> +</svg> diff --git a/doc/qtdesignstudio/images/studio-components.png b/doc/qtdesignstudio/images/studio-components.png Binary files differdeleted file mode 100644 index d72388e53b..0000000000 --- a/doc/qtdesignstudio/images/studio-components.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-connections.png b/doc/qtdesignstudio/images/studio-connections.png Binary files differdeleted file mode 100644 index 787bfbdc95..0000000000 --- a/doc/qtdesignstudio/images/studio-connections.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-editing-3d-scenes.png b/doc/qtdesignstudio/images/studio-editing-3d-scenes.png Binary files differindex 329e38b5c3..f5b29439a7 100644 --- a/doc/qtdesignstudio/images/studio-editing-3d-scenes.png +++ b/doc/qtdesignstudio/images/studio-editing-3d-scenes.png diff --git a/doc/qtdesignstudio/images/studio-gs.png b/doc/qtdesignstudio/images/studio-gs.png Binary files differdeleted file mode 100644 index 898826e83d..0000000000 --- a/doc/qtdesignstudio/images/studio-gs.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-help.png b/doc/qtdesignstudio/images/studio-help.png Binary files differdeleted file mode 100644 index 3cee0bf635..0000000000 --- a/doc/qtdesignstudio/images/studio-help.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-preview.png b/doc/qtdesignstudio/images/studio-preview.png Binary files differdeleted file mode 100644 index 4f943f3f8d..0000000000 --- a/doc/qtdesignstudio/images/studio-preview.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-project-wizards.png b/doc/qtdesignstudio/images/studio-project-wizards.png Binary files differindex 29a31a2e14..bdfb78546a 100644 --- a/doc/qtdesignstudio/images/studio-project-wizards.png +++ b/doc/qtdesignstudio/images/studio-project-wizards.png diff --git a/doc/qtdesignstudio/images/studio-projects.png b/doc/qtdesignstudio/images/studio-projects.png Binary files differdeleted file mode 100644 index 623bc1f872..0000000000 --- a/doc/qtdesignstudio/images/studio-projects.png +++ /dev/null diff --git a/doc/qtdesignstudio/images/studio-settings.png b/doc/qtdesignstudio/images/studio-settings.png Binary files differdeleted file mode 100644 index 2ac37ea853..0000000000 --- a/doc/qtdesignstudio/images/studio-settings.png +++ /dev/null diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc index 7e52e05838..82b9c0b807 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc @@ -220,4 +220,24 @@ \uicontrol {Export format options} field. You can remove metadata from PNG files, export assets as progressive JPG or compact SVG, and include SVG namespaces in SVG files. + + + \section1 Exporting Library Symbols + + \QBSK can handle symbols used from a local library. Before you use \QBSK to export a document + that contains remote symbols, you must annotate the Sketch document of the local library for + QML export. + + For more information about Sketch libraries, see Sketch documentation. + + You can either export the complete library with the document or unlink the symbols. + Unlinking the symbols exports the symbols as if the symbols were part of the document as + Group layers. + Exporting the complete library exports all the layers of the library irrespective of their usage + in the document. + + To export a library, select \uicontrol Export. \QBSK asks you whether you want to export the + complete library or to unlink the symbols. + + \image qt-sketch-bridge-library.png */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc b/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc index ad072db594..c9214a35a2 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc +++ b/doc/qtdesignstudio/src/qtdesignstudio-components.qdocinc @@ -44,7 +44,7 @@ independently of each other. \li \l Flipable provides a surface that can be flipped. \li \l Group provides an item with the size property. - \li \l Iso adds a container for an ISO 7000 icon. + \li \l {Iso}{Iso Icon} adds a container for an ISO 7000 icon. \li \l Pie adds a pie slice or a pie with a slice missing from it. \li \l Rectangle adds a rectangle with corners that you can shape independently of each other. @@ -60,7 +60,8 @@ You can use the project wizard to create a starting point for a custom \l [QtQuickControls2] {Button}, \l [QtQuickControls2] {Pane}, - \l [QtQuickControls2] {StackView}{Stack View}, or + \l [QtQuickControls2] {StackLayout}{Stacked Layout}, + \l [QtQuickControls2] {SwipeView}{Swipe View}, or \l [QtQuickControls2] {Switch}. \list 1 @@ -68,8 +69,8 @@ \uicontrol {Files and Classes} > \uicontrol {Qt Quick Controls}. \li Select the control to create, and then select \uicontrol Choose. - \note Components are listed in the \uicontrol {QML Components} - section of the \uicontrol Library only if the filename begins + \note Components are listed in the \uicontrol {My QML Components} + tab of the \uicontrol Library only if the filename begins with a capital letter. \li Edit component properties in the \uicontrol Properties view. diff --git a/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc index c09078339f..036879ad63 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc @@ -46,8 +46,7 @@ You can use wizards to create projects for the desktop or embedded Linux and Android devices. In addition, you can add individual QML - files, components, font loaders, and JavaScript files to your - projects. + files, components, and JavaScript files to your projects. \li \l{Using Git} diff --git a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc index f98f53349b..c545d0dab2 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -63,15 +63,22 @@ or create them from scratch using the following wizards: \list - \li \uicontrol General generates projects that are suitable for all - target platforms. - \omit - \li \uicontrol Embedded generates projects that work well on embedded - Linux devices. - \endomit - \li \uicontrol Mobile generates projects that work well on mobile - devices. - \li \uicontrol Desktop generates projects that work well on the desktop. + \li \uicontrol {MCU Support Application} creates an application that + uses a subset of \l{Qt QML} and \l{Qt Quick Controls} types (as + supported by Qt for MCUs) that you can deploy, run, and debug on + MCU boards. + \li \uicontrol {Qt Quick Application - Empty} creates a Qt Quick UI + project that uses \l{Qt Quick} types and can be run on all target + platforms. + \li \uicontrol {Qt Quick 3D Application} creates a Qt Quick UI project + that uses Qt Quick and \l{Qt Quick 3D} types. + \li \uicontrol {Qt Quick Application - Scroll} and + \uicontrol {Qt Quick Application - Stack} create a Qt Quick + application that uses Qt Quick Controls to implement a scrollable + list or a set of pages with a stack-based navigation model. + \li \uicontrol {Qt Quick Application - Launcher} creates a Qt Quick UI + project that uses Qt Quick types and defines a QML laucher + application. \endlist \section1 Using Project Wizards @@ -119,10 +126,12 @@ \list \li \uicontrol {Qt Quick Files} \list + \li \uicontrol {Flow Item} and \uicontrol {Flow View} generate + types that you can use to design the application flow. \li \uicontrol {Qt Quick File} generates a QML type with one of the following types as the root item: \l Item, \l Rectangle, \l Image, \l BorderImage, \l Flickable, - \l Row, \l Column, \l Flow, or \li Grid. + \l Row, \l Column, \l Flow, or \l Grid. \li \uicontrol {Qt Quick UI File} generates a UI form with one of the above types as the root item. \li \uicontrol {Qt Quick Views} generates a \l GridView or a @@ -141,17 +150,12 @@ \li \l [Qt Quick Controls 2] {SwipeView} enables users to navigate pages by swiping sideways. \endlist - \li \uicontrol {QML Files} - \list - \li \l FontLoader imports custom fonts to the project for - deployment to devices. For more information, see - \l {Using Custom Fonts}. - \li \l ListModel adds a list model to the project. - \endlist + \li \uicontrol ListModel adds a \l{ListModel}{list model} to the + project. \li \uicontrol {JavaScript File} generates files that you can use to write the application logic. This is useful for testing the application before the developers implement the application logic in C++, for example. For more information, see \l {Simulating Application Logic}. - \endlist + \endlist */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index eba0407984..349337a405 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -94,7 +94,7 @@ \li \l{Editing 3D Scenes} \list \li \l{Editing 3D Assets in Design Mode} - \li \l{Working in the 3D Editor} + \li \l{Working in 3D Editor} \li \l{Adding 3D Views} \li \l{Using 3D Components} \list diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc index 979ba94e13..5425477f9e 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc @@ -36,9 +36,9 @@ \table \row - \li \inlineimage studio-gs.png - \li \inlineimage studio-projects.png - \li \inlineimage studio-components.png + \li \inlineimage front-gs.png + \li \inlineimage front-projects.png + \li \inlineimage front-ui.png \li \inlineimage studio-animation.png \row \li \l{Getting Started} @@ -72,14 +72,14 @@ \endlist \row \li \inlineimage studio-3d-scenes.png - \li \inlineimage studio-preview.png - \li \inlineimage studio-settings.png - \li \inlineimage studio-help.png + \li \inlineimage front-preview.png + \li \inlineimage front-advanced.png + \li \inlineimage front-help.png \row \li \b {\l{Editing 3D Scenes}} \list \li \l{Editing 3D Assets in Design Mode} - \li \l{Working in the 3D Editor} + \li \l{Working in 3D Editor} \li \l{Adding 3D Views} \li \l{Using 3D Components} \endlist diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc index 3d9da455cb..e2457f512f 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-design-mode.qdoc @@ -35,57 +35,41 @@ \title Editing 3D Assets in Design Mode \QDS opens QML files that contain 3D scenes in the Design mode and the - scenes in the 3D editor. You can add imported 3D assets - to projects and edit them to create scenes and states, as well as the - transitions between them. + scenes in \uicontrol {3D Editor}. You can add imported 3D assets to projects + and edit them to create scenes and states, as well as the transitions + between them. The other views enable you to select QML types to use in the + scene, specify properties for them, and view them in a tree structure, + as well as to create connections and browse projects and files. \image studio-editing-3d-scenes.png "3D assets in Design mode" - To edit 3D scenes in the Design mode: + To open the following views, select \uicontrol Window > \uicontrol Views: \list \li \uicontrol {3D Editor} (1) is the working area where you create the scene, position the model, light and camera, as well as move and - scale items. - \li \uicontrol {3D View} (2) is where you see the scene projected by the - camera. - \li The sidebars contain views where you can select QML types to use in - the scene, specify properties for them, and view them in a tree - structure, as well as to create connections and browse projects and - files. You can select the content of the sidebars in the sidebar - menu: - \list - \li \uicontrol {Library} (3) displays the building blocks that you - can use to create scenes: predefined Qt Quick 3D Components, - Qt Quick Controls, your own 3D assets that you import to the - project, and other assets. For more information, see - \l {Adding 3D Views}. - \li \uicontrol {Navigator} (4) displays the items in the current QML - file as a tree structure. For more information, see - \l {Managing Item Hierarchy}. - \li \uicontrol {Properties} (5) organizes the properties of the - selected item. You can change the properties also in the - \uicontrol {Text Editor}. For more information, see - \l {Specifying Item Properties}. - \li \uicontrol Connections enables you to create connections - between objects, signals, and object properties. For more - information, see \l{Adding Connections}. - \li \uicontrol {File System} shows all files in the currently - selected directory. For more information, see - \l{Viewing the File System}. - \li \uicontrol {Open Documents} shows currently open files. - \li \uicontrol {Projects} shows a list of projects open in the - current session. For more information, see - \l{Viewing Project Files}. - \endlist - \li \uicontrol {States} displays the different states of the - item. QML states typically describe user interface configurations, - such as the UI controls, their properties and behavior and the - available actions. For more information, see \l{Adding States}. - \li \uicontrol Timeline (6) provides a timeline and keyframe based + scale items. For more information, see \l {Working in 3D Editor}. + \li \uicontrol {Form Editor} (2) is where you see the scene projected by + the camera. + \li \uicontrol {Library} (3) displays the building blocks that you + can use to create scenes: predefined Qt Quick 3D Components, + Qt Quick Controls, your own 3D assets that you import to the + project, and other assets. For more information, see \l {Adding 3D + Views}. + \li \uicontrol {Navigator} (4) displays the items in the current QML + file as a tree structure. For more information, see + \l {Managing Item Hierarchy}. + \li \uicontrol {Properties} (5) organizes the properties of the + selected item. You can change the properties also in the + \uicontrol {Text Editor}. For more information, see + \l {Specifying Item Properties}. + \li \uicontrol Connections (6) enables you to create connections + between objects, signals, and object properties. For more + information, see \l{Adding Connections}. + \li \uicontrol Timeline (7) provides a timeline and keyframe based editor that enables you to animate the properties of components. \endlist - To close the 3D editor, select \uicontrol 2D in the list on the toolbar (7). - To reopen it, select \uicontrol {2D/3D}. + For more information on other views, see + \l {Editing QML Files in Design Mode}. */ diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc index 5b7fe602d5..cc42cbc100 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-editor.qdoc @@ -28,75 +28,120 @@ \page studio-3d-editor.html \nextpage studio-3d-view.html - \title Working in the 3D Editor + \title Working in 3D Editor - To project a 3D scene to a 2D viewport, it is necessary to view the scene - from a \l{Using Scene Camera}{camera}. Select the \uicontrol {Toggle - Perspective/Orthographic Projection} button (1) on the 3D editor toolbar to - switch between a \e {perspective camera} and an \e {orthographic camera}. - A perspective camera uses field of view and near and far clip planes to - specify the projection, whereas an orthographic camera can be thought of - as a 2D camera. Both of them are free-form cameras that you can use to - orbit around the scene. + When editing a 3D scene, you view the scene in \uicontrol {3D Editor} by + using the \uicontrol {3D Editor} camera. You can switch between + \e {perspective camera} and \e {orthographic camera} modes. When using the + perspective camera mode, objects that are far from the camera appear smaller + than those nearby. In the orthographic camera mode, all objects appear at + the same scale irrespective of their distance from the camera. Both of them + are free-form camera modes that you can use to orbit around the scene. When you import 3D scenes from files that you exported from 3D graphics - tools, you also import the camera, light, model, and materials. If your - scene did not contain them, you can add the corresponding Qt Quick 3D - types from the \uicontrol Library. - - You can use the toolbar buttons (2) to show the \e transformation - gizmo in the \uicontrol {3D Editor} when an item is selected - and to determine what happens when you drag the selected item. - Transformation refers to moving, rotating, or scaling of an object. - Select the \uicontrol {Toggle Local/Global Orientation} button (3) to - determine whether the gizmos affect only the local transformations of the - item or whether they transform with respect to the global space. + tools, you also import a \l{Using Scene Camera}{scene camera}, + \l{Using Lights}{light}, \l{Adding Models}{model}, and + \l {Using Materials and Shaders}{materials}. If your scene did not contain + them, you can add the corresponding Qt Quick 3D types from \uicontrol + Library. + + You can use the toolbar buttons to \e transform 3D objects and manipulate + the 3D scene. Transformation refers to moving, rotating, or scaling of an + object. The \e pivot of the component is used as the origin for + transformations. You can set a \l{Setting Transform Properties}{local pivot + offset} for an item in \uicontrol Properties to transform the component + around a point other than its local origin. A line is drawn in \uicontrol + {3D Editor} from the pivot point to the center of the component to provide + a visual connection between them. + + Toggle between local and global orientation to determine whether the gizmos + affect only the local transformations of the item or whether they transform + with respect to the global space. + + Additional helpful features when editing 3D scenes are the \e {edit light}, + which is a quick way to light the scene, and the grid that helps you to + navigate in 3D space. Select the \inlineimage grid_on.png + (\uicontrol {Toggle Grid Visibility}) to show or hide the grid. \image studio-3d-editor.png "3D Editor" - The \e pivot of the component is used as the origin for position, scale, - and rotation operations. You can set a \l{Setting Transform Properties} - {local pivot offset} for an item in the \uicontrol Properties view to - manipulate the component around a point other than its local origin. A - line is drawn in the 3D editor from the pivot point to the center of the - component to provide a visual connection between them. + \section1 Controlling the 3D Editor Camera - \section1 Controlling the Edit View Camera + To switch to perspective camera mode, select + \inlineimage perspective_camera.png + (\uicontrol {Toggle Perspective/Orthographic Edit Camera}). + To switch to orthographic camera mode, select + \inlineimage orthographic_camera.png + . - You can add 3D camera types to the scene to project the view you see in - the View3D type in the application. While editing scenes, you can use - a separate \e {edit view camera} (4) to project the scene to the 3D edit - view in the Design mode. + You can navigate the scene by panning, rotating, and zooming the 3D Editor + camera: - You can navigate the scene by rotating, panning, and zooming the edit view - camera. - - To zoom, use the mouse wheel or press \key Alt and right-click anywhere in - the rendered view to zoom the view in or out as you drag up or down. - - To pan, press \key Alt and use the middle mouse button to click anywhere in - the rendered view to slide the view around. - - To orbit, press \key Alt and click anywhere in the rendered view to rotate - the view. + \list + \li To pan, press \key Alt and use the middle mouse button to click + anywhere in the rendered view to slide the view around. + \li To orbit, press \key Alt and click anywhere in the rendered view to + rotate the view. + \li To zoom, use the mouse wheel or press \key Alt and right-click + anywhere in the rendered view to zoom the view in or out as you drag + up or down. + \endlist - To scale the edit view camera and to focus it on the selected items, select - \uicontrol {Fit Selected} button or press \key F. + To zoom and focus the 3D Editor camera on a selected item, + select \inlineimage fit_selected.png + (\uicontrol {Fit Selected}) or press \key F. - The world axis helper (5) shows the direction of the world axes in respect - to the edit view camera. To point the camera at the currently selected + The world axis helper (1) shows the direction of the world axes in respect + to the 3D Editor camera. To point the camera at the currently selected component in the direction of an axis, click the axis. If no component is selected, the camera is pointed at the world origin. This does not affect the camera zoom level. - For more information about using the cameras in the scene, the available - 3D camera types, and their properties, see \l{Using Scene Camera}. + \image studio-3d-editor-axis-helper.png "Axis helper in 3D Editor" + + You can use scene cameras (2) to view the the View3D type from a specific + angle in \uicontrol {Form Editor} while editing scenes. Different types of + cameras are available in \uicontrol Library under \uicontrol + {Qt Quick 3D}. For more information about using cameras in the scene, + the available camera types, and their properties, see + \l{Using Scene Camera}. + + \section1 Using Global and Local Orientation + + To switch between local and global orientation, select + \inlineimage local.png + or \inlineimage global.png + (\uicontrol {Toggle Local/Global Orientation}) + or press \key Y. + + In global orientation mode, transformation of a selected object is presented + with respect to the global space. For example, while the move tool is + selected, selecting a cube will show its move gizmo aligned with the axes + of global space. Dragging on the red arrow of the gizmo moves the object in + the global x direction. + + In local orientation mode, the position of a selected object is shown + according to local axes specific to the selected object. For example, + selecting a rotated cube will show its axes rotated, and not aligned with + the axes of global space. Dragging on the red arrow of the gizmo + moves the object in the local x direction in relation to the object. + + \section1 Using Edit Light + + The edit light is an extra point light that follows the edit camera. + To switch the edit light on and off, select \inlineimage edit_light_on.png + or \inlineimage edit_light_off.png + (\uicontrol {Toggle Edit Light}) + or press \key U. + + For more information about the available scene light types and their + properties, see \l{Using Lights}. \section1 Selecting Items To move, rotate, or scale items in the scene, you need to select them first. The selection mode buttons determine how items are selected when you click - them in the 3D editor. + them in \uicontrol {3D Editor}: \list \li In the \inlineimage select_item.png @@ -111,80 +156,54 @@ \section1 Moving Items - \image studio-3d-editor-move.png "3D editor in move mode" + \image studio-3d-editor-move.png "3D Editor in move mode" You can move items in relation to their coordinate system, along the x, y, - or z view axis or on the top, bottom, left, and right clip planes of the - render camera. + or z axis or on the top, bottom, left, and right clip planes of the + \uicontrol {3D Editor} camera. To move items, select \inlineimage move_on.png - or press \key W. + or press \key W: - To move items along an axis, click the axis and drag the item along the - axis. - - To move items on a plane, select the plane handle and drag the item on - the plane. - - To move an item freely in the editor, select the handle at the center of - the item. + \list + \li To move items along the axes of the move gizmo, click the axis and + drag the item along the axis. + \li To move items on a plane, click the plane handle and drag the item + on the plane. + \li To move an item freely in the editor, click the gray handle at the + center of the item. + \endlist \section1 Rotating Items - You can rotate items around the view axes of the camera. - - \image studio-3d-editor-rotate.png "3D editor in rotate mode" + \image studio-3d-editor-rotate.png "3D Editor in rotate mode" To rotate items, select \inlineimage rotate_on.png - or press \key E. - - To rotate an item around an axis, select the axis and drag in the direction - you want to rotate the item in. - - To freely rotate the item, select the gray circle. - - \section1 Using Global and Local Orientation - - To switch between global and local orientation, select \uicontrol - {Toggle Local/Global Orientation}. + or press \key E: - In global orientation mode, transformation of a selected object is presented - with respect to the global space. For example, while the move tool is - selected, selecting a cube will show its move gizmo aligned with the axes - of global space. Dragging on the red arrow of the gizmo moves the object in - the global x direction. - - In local orientation mode, the position of a selected object is shown - according to local axes specific to the selected object. For example, - selecting a rotated cube will show its axes rotated, and not aligned with - the axes of global space. Dragging on the red arrow of the gizmo - moves the object in the local x direction in relation to the object. + \list + \li To rotate an item around its rotation gizmo, click the axis and + drag in the direction you want to rotate the item in. + \li To freely rotate the item, select the gray circle. + \endlist \section1 Scaling Items - \image studio-3d-editor-scale.png "3D editor in scale mode" - - To scale items, select \inlineimage scale_on.png - or press \key R. + \image studio-3d-editor-scale.png "3D Editor in scale mode" You can use the scale handles to adjust the local x, y, or z scale of an - item. You can adjust the scale across one, two, or three axes, depending - on the handle. - - To adjust the scale across one axis, select the scale handle attached to - the axis. To uniformly scale an item across all axes, select the handle - at the center of the item. + item. You can adjust the scale across one, two, or three axes, depending on + the handle. - To adjust the scale across a plane, select the plane handle and drag the - item on the plane. - - \section1 Using Edit View Light - - You use 3D light types to light the models in the scene. While editing - scenes, you can use a separate \e {edit view light} to illuminate the - portions of the scene that the scene lights do not hit. To switch the edit - view light on and off, select the \uicontrol {Toggle Edit Light} button (6). + To scale items, select \inlineimage scale_on.png + or press \key R: - For more information about the available scene light types and their - properties, see \l{Using Lights}. + \list + \li To adjust the scale across one axis, click and drag the scale handle + attached to the axis. + \li To adjust the scale across a plane, click the plane handle and drag + the item on the plane. + \li To uniformly scale an item across all axes, click and drag the + handle at the center of the item. + \endlist */ diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc index cfd19be883..361514e053 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-lights.qdoc @@ -42,6 +42,7 @@ \list \li \l{DirectionalLight}{Light Directional} \li \l{PointLight}{Light Point} + \li \l{SpotLight}{Light Spot} \li \l{AreaLight}{Light Area} \endlist @@ -121,6 +122,22 @@ Aside from fade, a point light has the same properties as a directional light. + \section1 Spot Light + + A spot light emits light towards one direction in a cone shape. + The light intensity diminishes when approaching the value of the + \uicontrol {Cone angle} property. The angle at which the light + intensity starts to diminish is defined by the + \uicontrol {Inner cone angle} property. Both angles are defined in degrees. + + Inside the inner cone angle, the spot light behaves similarly to the point + light. There the light intensity diminishes according to inverse-square-law. + However, the fade-off (and range) can be controlled with the + \uicontrol {Constant fade}, \uicontrol {Linear fade}, and + \uicontrol {Quadratic fade} properties. + + \image studio-3d-spot-light.png + \section1 Area Light An area light is similar to the directional light. However, instead of @@ -135,7 +152,7 @@ The image below shows an example on how to light an object with different colors using two different area lights. - \image area-light.png + \image studio-3d-area-light.png You can rotate, scale, and move area lights. diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc index bcef409407..54873e84d5 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc @@ -159,7 +159,7 @@ an easy way to add a high-quality look at a relatively low cost. To specify an image to use as the specular reflection map, set the - \uicontrol {Light probe} property + \uicontrol {Light probe} property. Crisp images cause your material to look very glossy. The more you blur your image, the softer your material appears. diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc index 16653e7f4b..8a54021a19 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-scene-environment.qdoc @@ -80,13 +80,12 @@ To clear the background using a color, select \uicontrol Color, and select the color in the \uicontrol {Clear Color} field. - To leave the scene uncleared, select \uicontrol {Unspecified}. - - \section1 Blending Scene Colors + To render a Skybox or Skydome instead of clearing the scene, + select \uicontrol SkyBox. You can specify the image to use as + a value of the \l{SceneEnvironment::lightProbe}{lightProbe} + property in \uicontrol {Text Editor}. - To determine how colors are blended, select a blend mode in the - \uicontrol {Blend mode} field. For more information on the options, - see \uicontrol {Blending Colors}. + To leave the scene uncleared, select \uicontrol {Unspecified}. \section1 Performing Depth Tests diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc index de74979357..3cc6c92d2f 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-view.qdoc @@ -30,32 +30,34 @@ \title Adding 3D Views - To display \l {Qt Quick 3D} types in the \uicontrol Library, select - \uicontrol Library > \uicontrol {QML Imports} > \uicontrol {Add Import} > - \uicontrol QtQuick3D. The types are displayed in the \uicontrol {QML Types} - tab. + You can use a wizard to create a Qt Quick 3D UI project that imports + the \l{Qt Quick 3D} QML types to the \uicontrol {QML Types} tab in + \uicontrol Library and contains a 3D view, scene light, camera, and + model. A default material is attached to the model. You can attach + textures to materials. For more information about creating projects, + see \l{Creating Projects}. + + To add a 3D view to some other kind of project and to display the Qt Quick + 3D QML types in \uicontrol Library, select \uicontrol Library > + \uicontrol {QML Imports} > \uicontrol {Add Import} > \uicontrol QtQuick3D. \image studio-qtquick-3d-components.png - To add a 3D view to the scene, drag and drop a \uicontrol {View 3D} - component from \uicontrol Library > \uicontrol {QML Types} > - \uicontrol {Qt Quick 3D} to the 3D editor or to the \uicontrol Navigator. - A 3D view contains a reference node that specifies a scene light, camera, - and model. A default material is attached to the model. You can attach - textures to materials. + To add components to the scene, drag and drop them to \uicontrol Navigator + or \uicontrol {Form Editor}. \image studio-navigator-view3d.png "View 3D component in the Navigator" By default, a directional light and a perspective camera are used. - To use other light and camera types, change the type of the component in - the \uicontrol Type field in the \uicontrol Properties view. For example, + To use other light and camera types, change the type of the component + in the \uicontrol Type field in \uicontrol Properties. For example, to use a point light, enter \e {PointLight}. \image studio-3d-properties-type.png "Type field in Properties view" - To edit component properties, select the component in the 3D editor - or in the \uicontrol Navigator and modify the property values in the - \uicontrol Properties view. + To edit component properties, select the component in + \uicontrol {Form Editor} or \uicontrol Navigator and + modify the property values in \uicontrol Properties. \image studio-qtquick-3d-view.png "View 3D component properties" diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc index 6a2939e5e9..ab65cea8f4 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d.qdoc @@ -68,7 +68,7 @@ \QDS opens QML files that contain 3D scenes in the Design mode and the scenes in the 3D editor. You can add imported 3D assets to projects as 3D components. - \li \l {Working in the 3D Editor} + \li \l {Working in 3D Editor} You can select 3D components in the 3D editor to move, rotate, and scale them in the scene projected by the camera. |
