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/qtcreator | |
| 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/qtcreator')
64 files changed, 216 insertions, 228 deletions
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 |
