diff options
Diffstat (limited to 'doc')
99 files changed, 365 insertions, 612 deletions
diff --git a/doc/qtcreator/config/qtcreator-project.qdocconf b/doc/qtcreator/config/qtcreator-project.qdocconf index 096548517d..ed35b4e41e 100644 --- a/doc/qtcreator/config/qtcreator-project.qdocconf +++ b/doc/qtcreator/config/qtcreator-project.qdocconf @@ -12,11 +12,9 @@ ignorewords += \ MinGW headerdirs = -sourcedirs = ../src \ - ../../qtdesignstudio/src/qtquick3d-editor +sourcedirs = ../src imagedirs = ../images \ - ../../qtdesignstudio/images \ ../../../src/libs/qmleditorwidgets/images \ ../../../src/libs/utils/images \ ../../../src/plugins/android/images \ @@ -27,14 +25,6 @@ imagedirs = ../images \ ../../../src/plugins/diffeditor/images \ ../../../src/plugins/help/images \ ../../../src/plugins/projectexplorer/images \ - ../../../src/plugins/qmldesigner/components/componentcore/images \ - ../../../src/plugins/qmldesigner/components/edit3d/images \ - ../../../src/plugins/qmldesigner/components/formeditor \ - ../../../src/plugins/qmldesigner/components/navigator \ - ../../../src/plugins/qmldesigner/components/timelineeditor/images \ - ../../../src/plugins/qmldesigner/componentsplugin/images \ - ../../../src/plugins/qmldesigner/qmlpreviewplugin/images \ - ../../../src/plugins/qmldesigner/qtquickplugin/images \ ../../../src/plugins/scxmleditor/common/images \ ../../../src/plugins/texteditor/images \ ../../../src/plugins/valgrind/images \ @@ -50,17 +40,12 @@ depends += qtandroidextras\ qtcmake \ qtcore \ qtqml \ - qtqmlmodels \ qtquick \ qmake \ qtdesigner \ qtdoc \ - qtgraphicaleffects \ qtgui \ qthelp \ - qtquick3d \ - qtquickcontrols \ - qtquickextras \ qtquicktimeline \ qtlinguist \ qtscxml \ diff --git a/doc/qtcreator/images/extraimages/qtcreator-extraimages.qdocconf b/doc/qtcreator/images/extraimages/qtcreator-extraimages.qdocconf index 9cd8ce979e..af81e51192 100644 --- a/doc/qtcreator/images/extraimages/qtcreator-extraimages.qdocconf +++ b/doc/qtcreator/images/extraimages/qtcreator-extraimages.qdocconf @@ -1,12 +1,2 @@ {HTML.extraimages,qhp.QtCreator.extraFiles} += \ - images/commercial.png \ - images/RfEYO-5Mw6s.jpg \ - images/yOUdg1o2KJM.jpg \ - images/DVWd_xMMgvg.jpg \ - images/Ed8WS03C-Vk.jpg \ - images/UfvA04CIXv0.jpg \ - images/FzmLuRHQXaw.jpg \ - images/pEETxSxYazg.jpg \ - images/V3Po15bNErw.jpg \ - images/bMXeeQw6BYs.jpg \ - images/u3kZJjlk3CY.jpg + images/commercial.png diff --git a/doc/qtcreator/images/qml-export-gimp.png b/doc/qtcreator/images/qml-export-gimp.png Binary files differdeleted file mode 100644 index 5c78a4013b..0000000000 --- a/doc/qtcreator/images/qml-export-gimp.png +++ /dev/null diff --git a/doc/qtcreator/images/qml-observer-context-menu.png b/doc/qtcreator/images/qml-observer-context-menu.png Binary files differdeleted file mode 100644 index c7d35b0db3..0000000000 --- a/doc/qtcreator/images/qml-observer-context-menu.png +++ /dev/null diff --git a/doc/qtcreator/images/qmldesigner-backends-add.png b/doc/qtcreator/images/qmldesigner-backends-add.png Binary files differdeleted file mode 100644 index a11ad9923c..0000000000 --- a/doc/qtcreator/images/qmldesigner-backends-add.png +++ /dev/null diff --git a/doc/qtcreator/images/qmldesigner-backends.png b/doc/qtcreator/images/qmldesigner-backends.png Binary files differdeleted file mode 100644 index f5eb6c26bc..0000000000 --- a/doc/qtcreator/images/qmldesigner-backends.png +++ /dev/null diff --git a/doc/qtcreator/images/qmldesigner-new-project.png b/doc/qtcreator/images/qmldesigner-new-project.png Binary files differindex 8554f7af89..7bab02c38f 100644 --- a/doc/qtcreator/images/qmldesigner-new-project.png +++ b/doc/qtcreator/images/qmldesigner-new-project.png diff --git a/doc/qtcreator/images/qtcreator-iso-icon-browser.png b/doc/qtcreator/images/qtcreator-iso-icon-browser.png Binary files differdeleted file mode 100644 index b59b319b1b..0000000000 --- a/doc/qtcreator/images/qtcreator-iso-icon-browser.png +++ /dev/null diff --git a/doc/qtcreator/images/qtcreator-live-preview.png b/doc/qtcreator/images/qtcreator-live-preview.png Binary files differindex 91d505dce9..4fd62939ab 100644 --- a/doc/qtcreator/images/qtcreator-live-preview.png +++ b/doc/qtcreator/images/qtcreator-live-preview.png diff --git a/doc/qtcreator/images/qtcreator-new-qt-quick-project-wizard.png b/doc/qtcreator/images/qtcreator-new-qt-quick-project-wizard.png Binary files differindex a2a5bf396f..d9d7509a8a 100644 --- a/doc/qtcreator/images/qtcreator-new-qt-quick-project-wizard.png +++ b/doc/qtcreator/images/qtcreator-new-qt-quick-project-wizard.png diff --git a/doc/qtcreator/images/qtcreator-new-subproject.png b/doc/qtcreator/images/qtcreator-new-subproject.png Binary files differindex e65a09bee6..7bab02c38f 100644 --- a/doc/qtcreator/images/qtcreator-new-subproject.png +++ b/doc/qtcreator/images/qtcreator-new-subproject.png diff --git a/doc/qtcreator/images/qtcreator-qt-quick-editors.png b/doc/qtcreator/images/qtcreator-qt-quick-editors.png Binary files differdeleted file mode 100644 index 2d06ea84b4..0000000000 --- a/doc/qtcreator/images/qtcreator-qt-quick-editors.png +++ /dev/null diff --git a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc index bdc1bda67e..05b89ebab8 100644 --- a/doc/qtcreator/src/debugger/qtquick-debugging.qdoc +++ b/doc/qtcreator/src/debugger/qtquick-debugging.qdoc @@ -244,7 +244,12 @@ You can change property values temporarily, without editing the source, and view the results in the running application. You can change the property - values permanently in the \uicontrol Properties view in the Design mode. + values permanently in + \if defined(qtcreator) + code. + \else + the \l Properties view. + \endif \section1 Applying QML Changes at Runtime diff --git a/doc/qtcreator/src/editors/creator-code-syntax.qdoc b/doc/qtcreator/src/editors/creator-code-syntax.qdoc index 1afc456647..7ba22031ed 100644 --- a/doc/qtcreator/src/editors/creator-code-syntax.qdoc +++ b/doc/qtcreator/src/editors/creator-code-syntax.qdoc @@ -433,45 +433,44 @@ \row \li M203 \li Warning - \li Imperative code is not supported in the Design mode + \li Imperative code is not supported in \QDS \li \row \li M204 \li Warning - \li This QML type is not supported in the Design mode + \li This QML type is not supported in \QDS \li \row \li M205 \li Warning - \li Reference to parent QML type cannot be resolved correctly by the - Design mode + \li Reference to parent QML type cannot be resolved correctly by \QDS \li \row \li M206 \li Warning \li This visual property binding cannot be evaluated in the local - context and might not show up in Design mode as expected + context and might not show up in \QDS as expected \li \row \li M207 \li Warning - \li Design mode only supports states in the root QML type + \li \QDS only supports states in the root QML type \li \row \li M208 \li Error - \li This id might be ambiguous and is not supported in the Design mode. + \li This id might be ambiguous and is not supported in \QDS. \li \row \li M209 \li Error - \li This type (type name) is not supported as a root element in the - Design mode. + \li This type (type name) is not supported as a root element in + \QDS. \li \row @@ -691,8 +690,7 @@ instead of Qt Quick 2}. You can see the error message when you move the mouse pointer over code that - \QC underlines in the code editor or when you open a QML file in the Design - mode. + \QC underlines in the code editor or when you open a QML file in \QDS. To reset the code model, select \uicontrol Tools > \uicontrol {QML/JS} > \uicontrol {Reset Code Model}. @@ -700,7 +698,7 @@ \if defined(qtcreator) If this does not help, try changing the QML emulation layer to the one that was built with the same Qt version as the one selected in the build and run - kit. For more information, see \l{Running QML Modules in Design Mode}. + kit. \endif \section1 Inspecting QML and JavaScript diff --git a/doc/qtcreator/src/editors/creator-quick-fixes.qdoc b/doc/qtcreator/src/editors/creator-quick-fixes.qdoc index efe8ecc058..0a063ee3ba 100644 --- a/doc/qtcreator/src/editors/creator-quick-fixes.qdoc +++ b/doc/qtcreator/src/editors/creator-quick-fixes.qdoc @@ -869,8 +869,10 @@ \image qtcreator-move-component-into-separate-file.png - \li QML type name. This action is also available in the - \uicontrol {Form Editor} in the Design mode. + \li QML type name. + \if defined(qtdesignstudio) + This action is also available in \l {Form Editor}. + \endif \row \li Split Initializer \li Reformats a one-line type into a multi-line type. For example, diff --git a/doc/qtcreator/src/external-resources/external-resources-qds.qdoc b/doc/qtcreator/src/external-resources/external-resources-qds.qdoc new file mode 100644 index 0000000000..48adc0a98f --- /dev/null +++ b/doc/qtcreator/src/external-resources/external-resources-qds.qdoc @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \externalpage https://doc.qt.io/qtdesignstudio/index.html + \title Qt Design Studio Manual +*/ +/*! + \externalpage https://doc.qt.io/qtdesignstudio/studio-optimized-3d-scenes.html + \title Creating Optimized 3D Scenes +*/ +/*! + \externalpage https://doc.qt.io/qtdesignstudio/qtquick-optimizing-designs.html + \title Optimizing Designs +*/ +/*! + \externalpage https://doc.qt.io/qtdesignstudio/studio-optimized-3d-scenes.html + \title Creating Optimized 3D Scenes +*/ diff --git a/doc/qtcreator/src/external-resources/external-resources.qdoc b/doc/qtcreator/src/external-resources/external-resources.qdoc index 09c650e3a9..a6ddbe1414 100644 --- a/doc/qtcreator/src/external-resources/external-resources.qdoc +++ b/doc/qtcreator/src/external-resources/external-resources.qdoc @@ -101,3 +101,11 @@ \externalpage http://developer.android.com/guide/components/fundamentals.html \title Android Application Fundamentals */ +/*! + \externalpage https://doc.qt.io/qt/qtqml-cppintegration-overview.html + \title Overview - QML and C++ Integration +*/ +/*! + \externalpage https://doc.qt.io/qt/qtqml-syntax-imports.html#qml-import-path + \title QML Import Path +*/ diff --git a/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc b/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc index 9d869b6254..56d78ffcd3 100644 --- a/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc +++ b/doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc @@ -580,10 +580,11 @@ \endtable \endif + \if defined(qtdesignstudio) \section2 Design Mode Keyboard Shortcuts You can use the following keyboard shortcuts when editing QML files in the - Design mode. + \uicontrol Design mode. \table \header @@ -603,6 +604,7 @@ \li Toggle right sidebar \li Ctrl+Alt+Shift+0 \endtable + \endif \section2 Debugging Keyboard Shortcuts diff --git a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc index 9b1c8bb3b3..9be304d716 100644 --- a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc +++ b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc @@ -104,7 +104,7 @@ \b {What should I do when \QC complains about missing OpenGL support?} - Some parts of \QC, such as the Design mode and QML Profiler, use Qt Quick 2, which + Some parts of \QC, such as QML Profiler, use Qt Quick 2, which relies on OpenGL API for drawing. Unfortunately, the use of OpenGL can cause problems, especially in remote setups and with outdated drivers. In these cases, \QC displays OpenGL-related error messages on the console or records diff --git a/doc/qtcreator/src/howto/creator-telemetry.qdoc b/doc/qtcreator/src/howto/creator-telemetry.qdoc index 746c4b4efb..8ae161c74e 100644 --- a/doc/qtcreator/src/howto/creator-telemetry.qdoc +++ b/doc/qtcreator/src/howto/creator-telemetry.qdoc @@ -84,7 +84,7 @@ \page collecting-usage-statistics.html \previouspage creator-telemetry.html \if defined(qtdesignstudio) - \nextpage collecting-user-feedback.html + \nextpage studio-user-feedback.html \else \nextpage creator-help-overview.html \endif @@ -116,67 +116,3 @@ that you do not want to transmit to the backend storage. \endlist */ - -/*! - \page collecting-user-feedback.html - \previouspage collecting-usage-statistics.html - \nextpage creator-crashpad.html - - \title Collecting User Feedback - - A pop-up survey asking for your feedback will appear for some of the features - after you have been using them for some time. You will be asked to to rate - the usefulness of the feature on a scale of one to five stars. You must rate - the feature with at least one star if you wish to submit your rating. You - are also encouraged to give additional written feedback. After you select - \uicontrol Skip or \uicontrol Submit, the pop-up survey will not appear for - the same feature again. - - \image studio-feedback-popup.png "User feedback pop-up survey for Flow Editor" - - For the pop-up survey to appear, you must enable collecting statistics, and - also allow collecting \uicontrol {4 - Detailed usage statistics} in - \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry > - \uicontrol {Usage Statistics} > \uicontrol {Telemetry mode}. - You can review the submitted user feedback in - \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry > - \uicontrol {Usage Statistics} > \uicontrol {Collected Data} by selecting - \uicontrol {Qt Quick Designer Usage of views and actions} in - \uicontrol {Data sources}. -*/ - -/*! - \page creator-crashpad.html - \previouspage collecting-user-feedback.html - \nextpage studio-packaging.html - - \title Reporting Crashes - - You can enable \QDS to report crashes automatically. \QDS uses Google - Crashpad to collect crashes and report them to the Sentry backend storage - for processing. The purpose of Crashpad is to capture application state in - sufficient detail to allow developers to diagnose and, where possible, fix - the issue causing the crash. Crashpad may capture arbitrary contents from - the memory of a crashed process, including user sensitive information, URLs, - and other content provided by the users. The collected reports are used for - the sole purpose of fixing bugs. For more information on Crashpad, see the - \l {https://chromium.googlesource.com/crashpad/crashpad/+/master/doc/overview_design.md} - {documentation} by Google. For more information on processing and storing - of the collected data, see \l {https://sentry.io/security/} - {Security & Compliance} by Sentry. - - To enable sending crash reports, select \uicontrol Tools > \uicontrol - Options > \uicontrol Environment > \uicontrol System - (\uicontrol {Qt Design Studio} > \uicontrol Preferences > \uicontrol - Environment > \uicontrol System on \macos), and then select - \uicontrol {Enable crash reporting}. - - Since crash reports take up disk space, you may wish to remove them when - they are no longer needed. Select \uicontrol {Clear local crash reports} to - remove the crash report data. - - \image studio-crashpad-checkbox.png "Checkbox for enabling crash reporting" - - \note Crashpad is currently only supported on Windows and \macos. - -*/ diff --git a/doc/qtcreator/src/overview/creator-only/creator-commercial-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-commercial-overview.qdoc index a227fe0d19..acb4548fb3 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-commercial-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-commercial-overview.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -40,7 +40,6 @@ \l{http://qt.io/licensing/}{Qt license}: \list - \li \l{Browsing ISO 7000 Icons} in the Design mode \li \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Developing for embedded devices} \li \l{http://doc.qt.io/qtcreator/creator-overview-qtasam.html} 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 1832facb55..5b530662a6 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-design-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-design-overview.qdoc @@ -38,16 +38,19 @@ \image front-ui.png - \QC provides integrated visual editors for designing Qt Quick and - widget-based applications in the Design mode. The integration - includes project management and code completion. + \QC provides an integrated visual editor designing widget-based applications + in the \uicontrol Design mode. The integration includes project management + and code completion. + + You can develop Qt Quick applications in the \uicontrol Edit mode or use + a separate visual editor, \QDS. \list \li \l{Developing Qt Quick Applications} You can use wizards to create Qt Quick projects containing - boiler-plate code that you can edit in the Design mode. + boiler-plate code that you can edit in the \uicontrol Edit mode. \li \l{Developing Widget Based Applications} diff --git a/doc/qtcreator/src/overview/creator-only/creator-issues.qdoc b/doc/qtcreator/src/overview/creator-only/creator-issues.qdoc index 578a289219..bac658aef5 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-issues.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-issues.qdoc @@ -143,15 +143,4 @@ {GCC Bugzilla - Bug 44731}. \endlist - - \section1 Design Mode Issues - - \list - - \li The Design mode uses a QML emulation layer (QML Puppet) to render and preview - images and to collect data. Executing C++ code might cause the QML - emulation layer to crash. If it crashes, an error message is displayed and - you can continue editing the QML file in the code editor. - - \endlist */ diff --git a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc index 98415f3760..6b4576e077 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc @@ -64,10 +64,8 @@ \l{Managing Projects}. \li \b {\l{Designing User Interfaces}} - \QC provides integrated visual editors for creating Qt Quick and - widget-based applications in the Design mode. To create intuitive, modern-looking, fluid user interfaces, you - can use \l{Qt Quick}. + can use \l{Qt Quick} and \QDS. If you need a traditional user interface that is clearly structured and enforces a platform look and feel, you can use the integrated \QD. For more information, see diff --git a/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc b/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc index 912863c18e..698289d48f 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-tutorials.qdoc @@ -46,7 +46,7 @@ \li \l{Creating a Qt Quick Application} - Learn how to use the Design mode to create a Qt Quick application. + Learn how to create a Qt Quick application. \li \l{Creating a Qt Widget Based Application} 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 d997de4a3d..34eeb024b0 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc @@ -89,7 +89,7 @@ files, as defined by the wizard. For example, if you choose to create a Qt Quick application, \QC generates a - QML file that you can modify in the Design mode. + QML file that you can modify in the \uicontrol Edit mode. \section1 Selecting Project Type @@ -108,7 +108,7 @@ you can deploy, run, and debug on MCU boards. For more information, see \l {Connecting MCUs}. \row - \li {1,2} Application (Qt) + \li {1,3} Application (Qt) \li Qt Widgets Application \li Uses \QD forms to design a Qt widget based user interface for the desktop and C++ to implement the application logic. @@ -116,24 +116,11 @@ \li Qt Console Application \li Uses a single main.cpp file. \row - \li {1,4} Application (Qt Quick) - \li Qt Quick Application - Empty + \li Qt Quick Application \li Creates a Qt Quick 2 application project that can contain both QML and C++ code. You can build the application and deploy it to desktop, embedded, and mobile target platforms. \row - \li Qt Quick Application - Scroll - \li Uses the \l{ScrollView} component to implement a scrollable - list view (requires Qt 5.9 or later). - \row - \li Qt Quick Application - Stack - \li Uses the \l{StackView} component to implement a set of pages - with a stack-based navigation model (requires Qt 5.7 or later). - \row - \li Qt Quick Application - Swipe - \li Uses the \l{SwipeView} component to implement a set of pages - with a swipe-based navigation model (requires Qt 5.7 or later). - \row \li {1,4} Application (Qt for Python) \li Qt for Python - Empty \li Creates a \l{https://doc.qt.io/qtforpython/index.html} diff --git a/doc/qtcreator/src/python/creator-python-project.qdocinc b/doc/qtcreator/src/python/creator-python-project.qdocinc index 7dc7ee6737..7543434e06 100644 --- a/doc/qtcreator/src/python/creator-python-project.qdocinc +++ b/doc/qtcreator/src/python/creator-python-project.qdocinc @@ -119,7 +119,8 @@ select \uicontrol {REPL Import File}. To also import all functions from the file, select \uicontrol {REPL Import *}. - Open the .ui file in the Design mode to create a widget-based UI in \QD. + Open the .ui file in the \uicontrol Design mode to create a widget-based UI + in \QD. The \uicontrol Window wizard adds similar code to the source file, without the UI bits. @@ -188,7 +189,8 @@ sys.exit(app.exec_()) \endcode - Open the .qml file in the Design mode to design a Qt Quick UI in \QMLD. + Open the .qml file in the \uicontrol Edit mode to design a Qt Quick UI, or + use \QDS. //! [python qml project wizards] */ diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index e38b0bdea6..c1ce9e2f2f 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -103,105 +103,9 @@ \li \l{Developing Qt Quick Applications} \list \li \l {Creating Qt Quick Projects} - \li \l {Design Views} - \list - \li \l{Form Editor} - \li \l{3D Editor} - \li \l{Library} - \li \l{Navigator} - \li \l{Properties} - \li \l{Connection View} - \li \l{States} - \li \l{Transition Editor} - \li \l{Timeline} - \li \l{Curve Editor} - \li \l{Text Editor} - \endlist - \li \l {Wireframing} - \list - \li \l {Components} - \list - \li \l {Preset Components} - \list - \li \l{Shapes} - \li \l{Text} - \li \l{Images} - \li \l{UI Controls} - \li \l{User Interaction Methods} - \li \l{Lists and Other Data Models} - \li \l{Animations} - \li \l{3D Views} - \li \l{Node} - \li \l{Group} - \li \l{Instanced Rendering} - \li \l{Skeletal Animation} - \li \l{3D Models} - \li \l{Materials and Shaders} - \li \l{Textures} - \li \l{3D Materials} - \li \l{3D Effects} - \li \l{Custom Shaders} - \li \l{Custom Effects and Materials} - \li \l{Lights} - \li \l{Cameras} - \li \l{Scene Environment} - \li \l{Morph Target} - \li \l{Repeater3D} - \li \l{Loader3D} - \endlist - \li \l {Creating Component Instances} - \li \l {Creating Custom Components} - \list - \li \l{Creating Buttons} - \li \l{Creating Scalable Buttons and Borders} - \endlist - \endlist - \li \l{Specifying Component Properties} - \li \l{Scalable Layouts} - \li \l{Using Custom Fonts} - \li \l{Annotating Designs} - \li \l{UI Files} - \endlist - \li \l{Prototyping} - \list - \li \l{Creating UI Logic} - \li \l{Simulating Complex Experiences} - \list - \li \l{Loading Placeholder Data} - \li \l{Using QML Modules with Plugins} - \endlist - \li \l {Dynamic Behaviors} - \list - \li \l{Adding Connections} - \list - \li \l{Connecting Components to Signals} - \li \l{Adding Bindings Between Properties} - \li \l{Specifying Dynamic Properties} - \li \l{Managing C++ Backend Objects} - \endlist - \li \l {Adding States} - \endlist - \li \l {Exporting 3D Assets} - \list - \li \l{Exporting from Blender}{Blender} - \li \l{Exporting from Maya}{Maya} - \endlist - \li \l{Importing 3D Assets} - \li \l{Exporting Components} - \endlist - \li \l{Motion Design} - \list - \li \l{Introduction to Animation Techniques} - \li \l{Creating Timeline Animations} - \li \l{Editing Easing Curves} - \li \l{Production Quality} - \li \l{Optimizing Designs} - \list - \li \l{Creating Optimized 3D Scenes} - \endlist - \endlist - \li \l {Browsing ISO 7000 Icons} \li \l {Converting UI Projects to Applications} + \li \l {UI Files} + \li \l {Using QML Modules with Plugins} \endlist \li \l{Developing Widget Based Applications} \list diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-development.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-development.qdoc index ee038bcd21..3f05a77c06 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-development.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-development.qdoc @@ -36,63 +36,30 @@ \title Developing Qt Quick Applications - \list - - \li \l {Creating Qt Quick Projects} - - You can use wizards to create Qt Quick projects. - - \li \l {Design Views} - - You can use several different editors and views in the - Design mode to develop Qt Quick applications. - - \li \l {Wireframing} - - Plan your UI properly. Know what elements, such as screens, - components, and states, you need. Create a descriptive wireframe - and acquire a detailed UI specification before you start to make - the process of creating the UI more efficient. - - \li \l {Prototyping} + You can develop Qt Quick applications in the \uicontrol Edit mode or use + a separate visual editor, \QDS. - After your UI wireframe has been approved, you can turn it into - an interactive prototype to ensure that you and the developers - share a common vision about the UI appearance and functionality. + If you have installed \QDS, and open a .ui.qml or a .qml file in \QC, it + asks you whether you would like to open the file in \QDS instead. Select + \uicontrol {Open in \QDS} to open the file in \QDS. To continue editing + the file in \QC, close the info bar. However, we do not recommend editing + \l{UI Files}{UI files} in the \uicontrol Edit mode, because it is easy to + add code that is not supported by \QDS. To hide the question, select + \uicontrol {Do Not Show Again}. - \li \l{Motion Design} + For more information about using \QDS, see \l{Qt Design Studio Manual}. - After the wireframing and prototyping phases, you can use the - supported motion design techniques to fine-tune your UI for - production. You can use different animation techniques for - different purposes. \QC supports common motion design techniques, - such as timeline and keyframe based animation and easing curves, - as well as screen-to-screen or state-to-state application flows - and data-driven UI logic animation. + For more information about \l{Qt QML}, \l{Qt Quick}, and \l{All QML Types} + {QML types}, see the Qt reference documentation available online and + in the \uicontrol Help mode. - \endlist - - For more information, watch a video that shows how to perform the tasks - above: - - \youtube pEETxSxYazg - - \section1 Related Topics + The following topics describe Qt Quick application development using \QC: \list - \li \l {Browsing ISO 7000 Icons} - - You can add ISO 7000 icons from a library delivered with \QC to - UIs and change their color. - - \li \l {Using QML Modules with Plugins} + \li \l {Creating Qt Quick Projects} - QML modules may use plugins to expose components defined in C++ to - QML applications. \QC cannot load the plugins to determine the - details of the contained components, and therefore, the modules must - provide extra type information for code completion and the semantic - checks to work correctly. + You can use wizards to create Qt Quick projects. \li \l {Converting UI Projects to Applications} @@ -101,11 +68,15 @@ convert them to Qt Quick Application projects that contain .pro, .cpp, and .qrc files. - \li \l {Exporting Components} + \li \l {UI Files} - \l{UI Files}{UI files} (.ui.qml) can be exported to - JSON metadata format and PNG assets. + If you switch between \QC and \QDS or cooperate with designers on + a project, you might encounter .ui.qml files. They are intended to + be edited in \QDS only, so you need to be careful not to break the + code. - \endlist + \li \l{Using QML Modules with Plugins} + You can load C++ plugins for QML to simulate data. + \endlist */ diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-connection-editor-backend.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-connection-editor-backend.qdoc deleted file mode 100644 index afd9d07e58..0000000000 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-connection-editor-backend.qdoc +++ /dev/null @@ -1,73 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Creator documentation. -** -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** -****************************************************************************/ - -/*! - \previouspage quick-dynamic-properties.html - \page quick-connections-backend.html - \nextpage quick-states.html - - \title Managing C++ Backend Objects - - Many applications provide QObject objects implemented in C++ that work as a - bridge between QML and C++. Such objects are typically registered with - \c qmlRegisterType or \c qmlRegisterSingletonType and then used by QML to - communicate with the C++ backend. Another example of such objects are the - state machines created by the \l {Using the Qt SCXML Compiler (qscxmlc)} - {Qt SCXML Compiler}. - - Backend objects in a QML file are accessible if the QML file contains the - required imports. In addition, for a non-singleton QObject, a dynamic - property that contains the QObject must be specified. - - A \e local QObject is instantiated in the current \e .qml file, as follows: - - \badcode - property MyType myType: MyType {}. - \endcode - - Otherwise the property is just defined, as follows: - - \badcode - property MyType myType - \endcode - - To manage backend objects: - - \list 1 - - \li Select \uicontrol {Connection View} > \uicontrol Backends to view - accessible backend objects. - \image qmldesigner-backends.png "Connection View, Backends tab" - \li Select the \inlineimage plus.png - (\uicontrol Add) button to add a backend object in the - \uicontrol {Add New C++ Backend} dialog. - \image qmldesigner-backends-add.png "Add New C++ Backend dialog" - \li In the \uicontrol Type field, select the backend QObject to add. - \li Select the \uicontrol {Define object locally} check box if the - QObject is not registered as a singleton. - \li Select \uicontrol OK to add the required import and to create the - property for a non-singleton object. - \endlist -*/ diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc index 56c481dd7c..b69f1dc22d 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc @@ -32,7 +32,7 @@ /*! \previouspage creator-visual-editor.html \page quick-projects.html - \nextpage creator-using-qt-quick-designer.html + \nextpage quick-converting-ui-projects.html \title Creating Qt Quick Projects @@ -47,24 +47,12 @@ \li Wizard Template \li Purpose \row - \li {1,4} Application (Qt Quick) - \li Qt Quick Application - Empty + \li Application (Qt) + \li Qt Quick Application \li Creates a Qt Quick 2 application project that can contain both QML and C++ code. You can build the application and deploy it to desktop, embedded, and mobile target platforms. \row - \li Qt Quick Application - Scroll - \li Uses the \l{ScrollView} component to implement a scrollable - list view (requires Qt 5.9 or later). - \row - \li Qt Quick Application - Stack - \li Uses the \l{StackView} component to implement a set of pages - with a stack-based navigation model (requires Qt 5.7 or later). - \row - \li Qt Quick Application - Swipe - \li Uses the \l{SwipeView} component to implement a set of pages - with a swipe-based navigation model (requires Qt 5.7 or later). - \row \li Application (Qt for Python) \li Qt for Python - Qt Quick Application \li Creates a Python project that contains an empty Qt Quick @@ -72,14 +60,13 @@ \row \li Other Project \li Qt Quick UI Prototype - \li Creates a \l{Creating Qt Quick UI Projects}{Qt Quick UI project} - with a single QML file that contains the main view. You can - preview Qt Quick 2 UI projects in the - \l{Validating with Target Hardware}{QML Scene preview tool}. - You do not need to build them, because they do not contain any - C++ code. - - Use this template only if you are prototyping. You cannot create + \li Creates a Qt Quick UI project with a single QML file that + contains the main view. You can preview Qt Quick 2 UI projects + in the QML Scene preview tool. You do not need to build them, + because they do not contain any C++ code. + + This project type is compatible with \QDS. However, use this + template only if you are prototyping. You cannot create a full application by using this template. Qt Quick UI projects cannot be deployed to embedded or mobile @@ -104,24 +91,17 @@ \list 1 \li Select \uicontrol File > \uicontrol {New File or Project} > - \uicontrol {Application (Qt Quick)}. + \uicontrol {Application (Qt)} > \uicontrol {Qt Quick Application} + > \uicontrol Choose. - \li Select the application type: - \list - \li \uicontrol {Qt Quick Application - Empty} - \li \uicontrol {Qt Quick Application - Scroll} - \li \uicontrol {Qt Quick Application - Stack} - \li \uicontrol {Qt Quick Application - Swipe} - \endlist - - \li Select \uicontrol Choose to open the \uicontrol {Project Location} - dialog. - - \li In the \uicontrol Name field, enter a name for the application. + \li In the \uicontrol {Project Location} dialog, \uicontrol Name field, + enter a name for the project. Keep in mind that you cannot easily + change the project name later. \li In the \uicontrol {Create in} field, enter the path for the project files. Select the \uicontrol {Use as default project location} check - box to create new projects in this folder by default. + box to create new projects in this folder by default. You can move + project folders later without problems. \li Select \uicontrol Next (or \uicontrol Continue on \macos) to open the \uicontrol {Define Build System} dialog. @@ -143,9 +123,8 @@ \note If you have not installed the Qt Virtual Keyboard module when you installed Qt, an error message will appear when you try to open - the \e main.qml in the \uicontrol {Form Editor} in the Design mode. - You can use the \l {Installing Qt}{Qt Maintenance Tool} to install - Qt Virtual Keyboard. + \e main.qml for editing. You can use the \l {Installing Qt} + {Qt Maintenance Tool} to install Qt Virtual Keyboard. \li Select \uicontrol Next to open the \uicontrol {Translation File} dialog. @@ -179,14 +158,8 @@ \endlist - For the Empty and Scroll applications, \QC creates a QML file, - \e main.qml, that you can modify in the \uicontrol {Form Editor} - or the \uicontrol {Text Editor}. - - For the Stack and Swipe applications, \QC generates two \l{UI Files}{UI files}, - \e Page1Form.ui.qml and \e Page2Form.ui.qml, that you can modify in the - \uicontrol {Form Editor} and a QML file, \e main.qml, that you can - modify in the \uicontrol {Text Editor} to add the application logic. + \QC creates a QML file, \e main.qml, that you can modify in the + \uicontrol Edit mode. \include creator-python-project.qdocinc python qml project wizards @@ -240,9 +213,7 @@ \note If you have not installed the Qt Virtual Keyboard module when you installed Qt, an error message will appear when you try to open - the \e main.qml in the \uicontrol {Form Editor} in the Design mode. - You can use the \l {Installing Qt}{Qt Maintenance Tool} to install - Qt Virtual Keyboard. + \e main.qml. \li Select \uicontrol Next to open the \uicontrol {Kit Selection} dialog. diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-iso-icon-browser.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-iso-icon-browser.qdoc deleted file mode 100644 index 48dbe68617..0000000000 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-iso-icon-browser.qdoc +++ /dev/null @@ -1,77 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Creator documentation. -** -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** -****************************************************************************/ - -/*! - \page qtquick-iso-icon-browser.html - \previouspage studio-3d-scene-environment.html - \nextpage quick-converting-ui-projects.html - - \title Browsing ISO 7000 Icons - - \commercial - - You can add icons from an ISO 7000 icon library that is installed with \QC - to Qt Quick applications (commercial only). You can use the - \uicontrol {ISO Icon Browser} to add a \l {Picture} component and select the - icon to use for the component. You can change the default color of the icon. - - \image qtcreator-iso-icon-browser.png - - \section1 Using ISO Icons in Applications - - \list 1 - - \li Create a new Qt Quick Application or open an application in \QC. - - \li Open the \l{UI Files}{UI file} (.ui.qml) in \l {Form Editor}. - - \li Select \l Library > \uicontrol Components > \inlineimage plus.png - > \uicontrol {QtQuick.Extras} to import the \l {Qt Quick Extras} - module. - - \li Drag and drop a \uicontrol Picture component from \uicontrol Library - to \l {Form Editor}. - - \li Right-click the picture component and select \uicontrol {Choose Icon} - to open the \uicontrol {ISO Icon Browser}. - - \li To find icons, select a criterion for filtering icons and enter a - search string. - - \li Select an icon in the list, and then select \uicontrol OK to add - the icon. - - \li To view the icon you added, press \key {Ctrl+R} (or \key {Cmd+R}) - to run the application. - - \li To adjust the icon color, select the icon on the canvas, and then - select \uicontrol {Edit Color} in the context menu. - - \endlist - - \QC generates a Qt resource file called \c iso-icons.qrc that adds the - icons as a part of your project for delivery with your application. - - */ diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc b/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc index 48ddb0569a..fad9db2bab 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc @@ -31,8 +31,7 @@ \list 1 \li Select \uicontrol File > \uicontrol {New File or Project} > - \uicontrol {Application (Qt Quick)} > - \uicontrol {Qt Quick Application - Empty}. + \uicontrol {Application (Qt)} > \uicontrol {Qt Quick Application}. \li Select \uicontrol Choose to open the \uicontrol {Project Location} dialog. @@ -82,8 +81,8 @@ \endlist - For more information about the settings that you skipped, see - \l{Creating Qt Quick Applications}. + For more information about the settings that you skipped and the other + templates available, see \l{Creating Qt Quick Applications}. //! [qtquick empty application] */ diff --git a/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc b/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc index 1f3f5c0adc..9a6a39645c 100644 --- a/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc @@ -29,8 +29,8 @@ \previouspage studio-porting-projects.html \nextpage creator-editor-external.html \else - \previouspage qtquick-iso-icon-browser.html - \nextpage creator-using-qt-designer.html + \previouspage quick-projects.html + \nextpage creator-quick-ui-forms.html \endif \title Converting UI Projects to Applications @@ -47,8 +47,7 @@ \endlist For more information about integrating QML and C++, see - \l{https://doc.qt.io/qt/qtqml-cppintegration-overview.html} - {Overview - QML and C++ Integration}. + \l{Overview - QML and C++ Integration}. You can use a Qt Creator wizard template to create a Qt Quick application that is built using the qmake build system and then copy the source files @@ -61,10 +60,8 @@ compiling them into the binary. The wizard automatically adds the \c QML_IMPORT_PATH option to the project - file for specifying the required - \l{https://doc.qt.io/qt/qtqml-syntax-imports.html#qml-import-path} - {QML import path}. The path is only needed if more than one subdirectory - contains QML files. + file for specifying the required \l{QML Import Path}{QML import path}. The + path is only needed if more than one subdirectory contains QML files. Then you can use the \l QQuickView class in the main C++ source file to show the main QML file when the application starts. @@ -90,8 +87,8 @@ \list 1 \li Select \uicontrol File > \uicontrol {New File or Project} > - \uicontrol {Application (Qt Quick)} > - \uicontrol {Qt Quick Application - Empty} > \uicontrol Choose. + \uicontrol {Application (Qt)} > \uicontrol {Qt Quick Application} > + \uicontrol Choose. \li In the \uicontrol {Build system} field, select \l qmake as the build system to use for building and running the project, and then select \uicontrol Next (or \uicontrol Continue on \macos). @@ -151,9 +148,13 @@ \section1 Adding Custom Fonts - To \l{Using Custom Fonts}{use custom fonts} from the Qt Quick UI project, - call the QFontDatabase::addApplicationFont() function from the \e {main.cpp} - file. + \if defined(qtdesignstudio) + To \l{Using Custom Fonts}{use custom fonts} + \else + To use custom fonts + \endif + from the Qt Quick UI project, call the QFontDatabase::addApplicationFont() + function from the \e {main.cpp} file. \section1 Adding Qt Quick Designer Components to Qt Installations diff --git a/doc/qtcreator/src/qtquick/qtquick-live-preview-desktop.qdoc b/doc/qtcreator/src/qtquick/qtquick-live-preview-desktop.qdoc index a87e833683..5031c56938 100644 --- a/doc/qtcreator/src/qtquick/qtquick-live-preview-desktop.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-live-preview-desktop.qdoc @@ -30,6 +30,12 @@ \title Previewing on Desktop + \if defined(qtcreator) + To preview the currently active QML file on the desktop, select + \uicontrol Build > \uicontrol {QML Preview}. + + \image qtcreator-live-preview.png + \else To preview the currently active QML file on the desktop: \list @@ -39,24 +45,21 @@ \li Press \key {Alt+P}. \endlist - \if defined(qtcreator) - \image qtcreator-live-preview.png - \else \image studio-live-preview.png \endif To preview any QML file that belongs to the project, right-click the project - name in the \uicontrol Projects view, and select \uicontrol {Preview file}. + name in the \l Projects view, and select \uicontrol {Preview File}. + \if defined(qtdesignstudio) To preview the whole UI, select \uicontrol {Show Live Preview} - when viewing the main QML UI file of the project. + when viewing the main QML file of the project. To view the UI in different sizes, select the zooming level on the toolbar. The frames-per-second (FPS) refresh rate of animations is displayed in the \uicontrol FPS field. - \if defined(qtdesignstudio) \section1 Selecting the Preview Tool By default, the QML runtime is used for previewing. To use some diff --git a/doc/qtcreator/src/qtquick/qtquick-live-preview.qdoc b/doc/qtcreator/src/qtquick/qtquick-live-preview.qdoc index 42455f4400..47028e00a2 100644 --- a/doc/qtcreator/src/qtquick/qtquick-live-preview.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-live-preview.qdoc @@ -25,7 +25,11 @@ /*! \page creator-live-preview.html + \if defined(qtdesignstudio) \previouspage quick-states.html + \else + \previouspage creator-building-running.html + \endif \nextpage creator-live-preview-desktop.html \title Validating with Target Hardware @@ -56,8 +60,7 @@ \list \li \l{Previewing on Desktop} - You can preview individual QML files or the whole UI in the - Design mode. + You can preview individual QML files or the whole UI. \li \l{Previewing on Devices} \if defined(qtcreator) diff --git a/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc index 31b69054fa..85f7c0135b 100644 --- a/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-modules-with-plugins.qdoc @@ -33,10 +33,11 @@ \page creator-qml-modules-with-plugins.html \if defined(qtdesignstudio) \previouspage studio-simulink.html + \nextpage qtquick-adding-dynamics.html \else - \previouspage qtquick-placeholder-data.html + \previouspage creator-quick-ui-forms.html + \nextpage creator-using-qt-designer.html \endif - \nextpage qtquick-adding-dynamics.html \title Using QML Modules with Plugins @@ -45,7 +46,12 @@ the contained components, and therefore, the modules must provide extra type information for code completion and the semantic checks to work correctly. - To create a QML module and make it appear in the \l Library view: + To create a QML module + \if defined(qtdesignstudio) + and make it appear in the \l Library view: + \else + : + \endif \list 1 @@ -69,29 +75,27 @@ \li Create a directory named \c designer in your module directory. \li Create a \c .metainfo file for your module and place it in the - \c designer directory. Meta information is needed to display the + \c designer directory. + \if defined(qtdesignstudio) + Meta information is needed to display the components in the \uicontrol Components tab in \uicontrol Library. + \endif Use a metainfo file delivered with Qt, such as \c qtquickcontrols2.metainfo, as an example. \if defined(qtcreator) \li Import the module into the project, as instructed in \l {Importing QML Modules}. - - \li Make sure that the QML emulation layer used in the Design mode is built with - the same Qt version as your QML modules. For more information, see - \l {Running QML Modules in Design Mode}. You can also try - skipping this step and take it later, if necessary. + \endlist \else \li Build your module using the same Qt version and compiler as \QDS. For more information, see \l {Running QML Modules in Design Mode}. - \endif - - \endlist + \endlist Your module should now appear in the \uicontrol Components tab in \uicontrol Library. Your components should appear in a subsection of the \uicontrol Components tab if a valid \c .metainfo file is in place. + \endif \if defined(qtcreator) \section1 Registering QML Types @@ -105,9 +109,6 @@ complain about unknown types. However, this works only when the source code is available, and therefore, you must explicitly generate type information for QML modules with plugins before distributing them. - - Classes registered with \c qmlRegisterType() can be used as backend objects - in the Design mode. For more information, see \l {Adding Connections}. \endif \section1 Generating qmltypes Files @@ -168,26 +169,16 @@ \endcode The import path affects all the targets built by the CMake project. - \endif + \else \section1 Running QML Modules in Design Mode - A QML emulation layer (also called QML Puppet) is used in the Design mode to - render and preview images and to collect data. To be able to render custom components - correctly from QML modules, the emulation layer must be built with the same - Qt version and compiler as the QML modules. + A QML emulation layer (also called QML Puppet) is used in the + \uicontrol Design mode to render and preview images and to collect + data. To be able to render custom components correctly from QML modules, + the emulation layer must be built with the same Qt version and compiler + as the QML modules. - \if defined(qtcreator) - By default, a fallback emulation layer is provided by \QC and built with the same - Qt version as \QC. Therefore, your QML modules will mostly not work out of - the box. - - To use an emulation layer that is built with the Qt - configured in the build and run kit for the project, select \uicontrol Tools > - \uicontrol Options > \uicontrol {Qt Quick} > \uicontrol {Qt Quick Designer} > - \uicontrol {Use QML emulation layer which is built by the selected Qt} radio button. - \QC builds the emulation layer when you select the Design mode. - \else On Windows, select \uicontrol Help > \uicontrol {About Qt Design Studio} to check the Qt version and compiler that you need to use to build your plugin. For example: \c {Based on Qt 5.15.2 (MSVC 2019, 64 bit)}. @@ -195,21 +186,20 @@ On macOS, select \uicontrol {Qt Design Studio} > \uicontrol {About Qt Design Studio} to see something like: \c {Based on Qt 5.15.2 (Clang 10.0 (Apple), 64 bit)}. - \endif - A plugin should behave differently depending on whether it is run by the emulation layer or an application. For example, animations should not be run - in the Design mode. You can use the value of the \c QML_PUPPET_MODE + in the \uicontrol Design mode. You can use the value of the \c QML_PUPPET_MODE environment variable to check whether the plugin is currently being run - by an application or edited in the Design mode. + by an application or edited in the \uicontrol Design mode. - If you want to use a different module in the Design mode than in your actual - application for example to mockup C++ items, then you can use \c{QML_DESIGNER_IMPORT_PATH} + If you want to use a different module in the \uicontrol Design mode + than in your actual application for example to mockup C++ items, + you can use \c{QML_DESIGNER_IMPORT_PATH} in the \c{.pro} file (for qmake projects), or declare and set the property \c qmlDesignerImportPaths in your product (for Qbs projects). Modules in the import paths defined in \c{QML_DESIGNER_IMPORT_PATH} will be - used only in the Design mode. + used only in the \uicontrol Design mode. For an example, see \l {Qt Quick Controls - Contact List}. - + \endif */ diff --git a/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc b/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc index de00b1e0ed..33c88a9ae3 100644 --- a/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-toolbars.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -56,7 +56,13 @@ \section1 Previewing Images The Qt Quick Toolbar for images allows you to edit the properties of - \l {Border Image} and \l {Images}{Image} items. + \l {Border Image} and + \if defined(qtdesignstudio) + \l {Images}{Image} items. + \else + \l Image items. + \endif + You can scale and tile the images, replace them with other images, preview them, and change the image margins. @@ -97,8 +103,12 @@ \section1 Editing Rectangles The Qt Quick Toolbar for rectangles allows you to edit the properties of - \l {basic-rectangle}{Rectangle} items. You can change the fill and border - colors and add gradients. + \if defined(qtdesignstudio) + \l {basic-rectangle}{Rectangle} + \else + Rectangle + \endif + items. You can change the fill and border colors and add gradients. \image qml-toolbar-rectangle.png "Qt Quick Toolbar for rectangles" diff --git a/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc b/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc index 71fddd3d06..fb76d5250c 100644 --- a/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-ui-forms.qdoc @@ -35,18 +35,24 @@ \previouspage studio-advanced.html \nextpage creator-telemetry.html \else - \previouspage qtquick-annotations.html - \nextpage qtquick-prototyping.html + \previouspage quick-converting-ui-projects.html + \nextpage creator-qml-modules-with-plugins.html \endif \title UI Files - You can use \QC wizards to create UI files that have the filename + \if defined(qtdesignstudio) + You can use \QDS wizards to create UI files that have the filename extension \e .ui.qml. The UI files can be edited in \l {Form Editor}. If you use \l {Text Editor} to add code that is not supported - by \uicontrol {Form Editor}, \QC displays error messages. + by \uicontrol {Form Editor}, \QDS displays error messages. + \else + If you switch between \QC and \QDS or cooperate with designers on + a project, you might encounter UI files (.ui.qml). They are intended to + be edited in \QDS only. + \endif - The following features are not supported: + The following features are not supported in .ui.qml files: \list \li JavaScript blocks @@ -162,6 +168,7 @@ For more information about using the methods, see \l{https://doc.qt.io/qt/qml-qtqml-qt.html}{Qt QML Methods}. + \if defined(qtdesignstudio) \section1 Using UI Files You can edit the UI files in the \l {Form Editor} and @@ -207,5 +214,5 @@ implementation of a component in the .qml file, right-click the component and select \uicontrol {Go to Implementation} in the context menu. - + \endif */ diff --git a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc index 35792c6b69..630c0a1996 100644 --- a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc @@ -33,6 +33,7 @@ If you cannot see a file in the \l Projects view, switch to the \uicontrol {File System} view, which shows all the files in the file system. + \if defined(qtdesignstudio) The following image displays the \uicontrol {File System} view in the \uicontrol Design mode: @@ -89,6 +90,7 @@ \endlist \section1 File System View in Sidebar + \endif In the \uicontrol Edit and \uicontrol Debug mode, the \uicontrol {File System} view is displayed in the \l{Working with Sidebars} diff --git a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc index 64358b87aa..c64809d8f2 100644 --- a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc @@ -35,8 +35,13 @@ \image qtcreator-open-documents-view.png "Open Documents view" You can use the context menu to apply some of the functions also available - in the \uicontrol File menu and in the \l {File System Context Menu} - {File System} view to the file that is selected in the view. + in the \uicontrol File menu + \if defined(qtcreator) + . + \else + and in the \l {File System Context Menu} {File System} view to the file + that is selected in the view. + \endif In addition, you can: diff --git a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc index a9f50806f4..cc9f5cbcfe 100644 --- a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc @@ -40,6 +40,7 @@ the build system structure of the project and lists all files that are part of the project. + \if defined(qtdesignstudio) The following image displays the \uicontrol Projects view in the \uicontrol Design mode: @@ -65,14 +66,6 @@ configuration files. \endlist - \if defined(qtcreator) - Files that are not sources or data can be still included into a project's - distribution tarball by adding their paths to the \c DISTFILES variable in - the .pro file. This way they also become known to \QC, so that they are - visible in the \uicontrol Projects view and are known to the locator and - search. - \endif - \section1 Projects View Context Menu The \uicontrol Projects view contains context menus for managing projects, @@ -114,6 +107,7 @@ the \l {File System} view. \section1 Projects View in Sidebar + \endif In the \uicontrol Edit and \uicontrol Debug mode, the \uicontrol Projects view is displayed in the \l{Working with Sidebars}{sidebar}. It has a diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc index 5bf6d48689..7711dbd01f 100644 --- a/doc/qtcreator/src/user-interface/creator-ui.qdoc +++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc @@ -292,11 +292,6 @@ \uicontrol View > \uicontrol {Mode Selector Style} > \uicontrol Hidden. To only show icons on the mode selector, select the \uicontrol {Icons Only} style. - - The following image displays an example application in \uicontrol Edit mode (1) - and \uicontrol Design mode (2). - - \image qtcreator-qt-quick-editors.png "Edit mode and Design mode" \endif You can use \QC in the following modes: diff --git a/doc/qtcreator/src/user-interface/creator-views.qdoc b/doc/qtcreator/src/user-interface/creator-views.qdoc index dd45f9411e..65e44a03a9 100644 --- a/doc/qtcreator/src/user-interface/creator-views.qdoc +++ b/doc/qtcreator/src/user-interface/creator-views.qdoc @@ -70,10 +70,10 @@ files are included in the current file and which files include the current file. \endlist - \endif - + \else For more information about views that are only available when editing QML - files in the Design mode, see \l{Design Views}. + files in the \uicontrol Design mode, see \l{Design Views}. + \endif The additional options in a particular view are described in the following sections. diff --git a/doc/qtcreator/src/widgets/creator-faq-qtdesigner.qdocinc b/doc/qtcreator/src/widgets/creator-faq-qtdesigner.qdocinc index f341ce664c..64a607ab05 100644 --- a/doc/qtcreator/src/widgets/creator-faq-qtdesigner.qdocinc +++ b/doc/qtcreator/src/widgets/creator-faq-qtdesigner.qdocinc @@ -28,12 +28,12 @@ \section1 Qt Designer Integration Questions - \b {Why are custom widgets not loaded in Design mode even though it - works in standalone Qt Designer?} + \b {Why are custom widgets not loaded in the \uicontrol Design mode even though + it works in standalone \QD?} - Qt Designer fetches plugins from standard locations and loads the plugins + \QD fetches plugins from standard locations and loads the plugins that match its build key. The locations are different for standalone and - integrated Qt Designer. + integrated \QD. For more information, see \l{Adding Qt Designer Plugins}. diff --git a/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc b/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc index e2342dbe41..42a547d44f 100644 --- a/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc +++ b/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc @@ -30,7 +30,7 @@ // ********************************************************************** /*! - \previouspage creator-exporting-qml.html + \previouspage creator-qml-modules-with-plugins.html \page creator-using-qt-designer.html \nextpage adding-plugins.html diff --git a/doc/qtcreator/src/qtquick/qtquick-animation-types.qdoc b/doc/qtdesignstudio/src/components/qtquick-animation-types.qdoc index f8ffb2918d..f8ffb2918d 100644 --- a/doc/qtcreator/src/qtquick/qtquick-animation-types.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-animation-types.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-buttons.qdoc b/doc/qtdesignstudio/src/components/qtquick-buttons.qdoc index a92328e038..a92328e038 100644 --- a/doc/qtcreator/src/qtquick/qtquick-buttons.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-buttons.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-component-context-menu.qdocinc b/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc index af83a8e918..af83a8e918 100644 --- a/doc/qtcreator/src/qtquick/qtquick-component-context-menu.qdocinc +++ b/doc/qtdesignstudio/src/components/qtquick-component-context-menu.qdocinc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-component-instances.qdoc b/doc/qtdesignstudio/src/components/qtquick-component-instances.qdoc index eb2e12f8f9..eb2e12f8f9 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-component-instances.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-component-instances.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-components-custom.qdoc b/doc/qtdesignstudio/src/components/qtquick-components-custom.qdoc index dc7ba75268..dc7ba75268 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-components-custom.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-components-custom.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-components.qdoc b/doc/qtdesignstudio/src/components/qtquick-components.qdoc index d41d4d0bd3..d41d4d0bd3 100644 --- a/doc/qtcreator/src/qtquick/qtquick-components.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-components.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-controls.qdoc b/doc/qtdesignstudio/src/components/qtquick-controls.qdoc index a9153f6bcf..a9153f6bcf 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-controls.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-controls.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-data-models.qdoc b/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc index 2f07c78861..2f07c78861 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-data-models.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-data-models.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-images.qdoc b/doc/qtdesignstudio/src/components/qtquick-images.qdoc index 407c2715b5..407c2715b5 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-images.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-images.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-pathview-editor.qdocinc b/doc/qtdesignstudio/src/components/qtquick-pathview-editor.qdocinc index 83bd827f39..83bd827f39 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-pathview-editor.qdocinc +++ b/doc/qtdesignstudio/src/components/qtquick-pathview-editor.qdocinc diff --git a/doc/qtcreator/src/qtquick/qtquick-positioning.qdoc b/doc/qtdesignstudio/src/components/qtquick-positioning.qdoc index 1076e7a374..1076e7a374 100644 --- a/doc/qtcreator/src/qtquick/qtquick-positioning.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-positioning.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-preset-components.qdoc b/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc index 488dbbdfe0..488dbbdfe0 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-preset-components.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-preset-components.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-shapes.qdoc b/doc/qtdesignstudio/src/components/qtquick-shapes.qdoc index a174a52ab1..a174a52ab1 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-shapes.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-shapes.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-text.qdoc b/doc/qtdesignstudio/src/components/qtquick-text.qdoc index 8202082341..8202082341 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-text.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-text.qdoc diff --git a/doc/qtcreator/src/qtquick/library/qtquick-user-interaction-methods.qdoc b/doc/qtdesignstudio/src/components/qtquick-user-interaction-methods.qdoc index 408a5b6a84..408a5b6a84 100644 --- a/doc/qtcreator/src/qtquick/library/qtquick-user-interaction-methods.qdoc +++ b/doc/qtdesignstudio/src/components/qtquick-user-interaction-methods.qdoc diff --git a/doc/qtcreator/src/qtquick/qtdesignstudio-simulation-overview.qdoc b/doc/qtdesignstudio/src/overviews/qtdesignstudio-simulation-overview.qdoc index e5899fe3de..b62198deb8 100644 --- a/doc/qtcreator/src/qtquick/qtdesignstudio-simulation-overview.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtdesignstudio-simulation-overview.qdoc @@ -30,14 +30,11 @@ \title Simulating Complex Experiences - \QDS enables you to connect UIs to different forms of data from various sources, such as QML-based data models, JavaScript files, and backend - services. - \if definded(qtdesignstudio) - You can also connect your UI to Simulink to load live data from a + services. You can also connect your UI to Simulink to load live data from a Simulink simulation. - \endif + \list \li \l{Loading Placeholder Data} @@ -46,7 +43,6 @@ you can test grid, list, or path views, even though you don't have access to real data. - \if defined(qtdesignstudio) \li \l{Simulating Application Logic} You can use JavaScript to generate mock data for your UI. @@ -56,7 +52,6 @@ Use the Simulink connector to connect a Simulink Simulation Model to your UI. Simulink is a MATLAB-based graphical programming environment for modeling, simulating, and analyzing multi-domain dynamic systems. - \endif \li \l{Using QML Modules with Plugins} diff --git a/doc/qtcreator/src/qtquick/qtquick-animation-overview.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-animation-overview.qdoc index 672e62c8ae..672e62c8ae 100644 --- a/doc/qtcreator/src/qtquick/qtquick-animation-overview.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-animation-overview.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-annotations.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-annotations.qdoc index 8c493319b9..8c493319b9 100644 --- a/doc/qtcreator/src/qtquick/qtquick-annotations.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-annotations.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-creating-ui-logic.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc index 1b7be83102..1b7be83102 100644 --- a/doc/qtcreator/src/qtquick/qtquick-creating-ui-logic.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-creating-ui-logic.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-export.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc index 2aed8fea62..2aed8fea62 100644 --- a/doc/qtcreator/src/qtquick/qtquick-export.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-fonts.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-fonts.qdoc index bf79ffa20b..bf79ffa20b 100644 --- a/doc/qtcreator/src/qtquick/qtquick-fonts.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-fonts.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-motion-design.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-motion-design.qdoc index 91f842e08e..91f842e08e 100644 --- a/doc/qtcreator/src/qtquick/qtquick-motion-design.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-motion-design.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-optimizing-designs.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc index 0f6c31fe84..0f6c31fe84 100644 --- a/doc/qtcreator/src/qtquick/qtquick-optimizing-designs.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-optimizing-designs.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-placeholder-data.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-placeholder-data.qdoc index e684cfda63..237cfc67ef 100644 --- a/doc/qtcreator/src/qtquick/qtquick-placeholder-data.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-placeholder-data.qdoc @@ -25,17 +25,12 @@ /*! \page qtquick-placeholder-data.html - \previouspage studio-simulation-overview.html - \if defined(qtdesignstudio) \nextpage studio-javascript.html - \else - \nextpage creator-qml-modules-with-plugins.html - \endif \title Loading Placeholder Data - \QC supports views, models, and delegates, so that when you add + \QDS supports views, models, and delegates, so that when you add a Grid View, List View, or Path View component, the ListModel and the delegate component are added automatically. diff --git a/doc/qtcreator/src/qtquick/qtquick-production-quality-animation.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc index bfdf435cf6..bfdf435cf6 100644 --- a/doc/qtcreator/src/qtquick/qtquick-production-quality-animation.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-production-quality-animation.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-prototyping.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc index 1e9c784000..1e9c784000 100644 --- a/doc/qtcreator/src/qtquick/qtquick-prototyping.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-uis.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc index 3cb66337fc..3cb66337fc 100644 --- a/doc/qtcreator/src/qtquick/qtquick-uis.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc diff --git a/doc/qtdesignstudio/src/overviews/studio-crashpad.qdoc b/doc/qtdesignstudio/src/overviews/studio-crashpad.qdoc new file mode 100644 index 0000000000..e195977f8b --- /dev/null +++ b/doc/qtdesignstudio/src/overviews/studio-crashpad.qdoc @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! + \page studio-crashpad.html + \previouspage studio-user-feedback.html + \nextpage studio-packaging.html + + \title Reporting Crashes + + You can enable \QDS to report crashes automatically. \QDS uses Google + Crashpad to collect crashes and report them to the Sentry backend storage + for processing. The purpose of Crashpad is to capture application state in + sufficient detail to allow developers to diagnose and, where possible, fix + the issue causing the crash. Crashpad may capture arbitrary contents from + the memory of a crashed process, including user sensitive information, URLs, + and other content provided by the users. The collected reports are used for + the sole purpose of fixing bugs. For more information on Crashpad, see the + \l {https://chromium.googlesource.com/crashpad/crashpad/+/master/doc/overview_design.md} + {documentation} by Google. For more information on processing and storing + of the collected data, see \l {https://sentry.io/security/} + {Security & Compliance} by Sentry. + + To enable sending crash reports, select \uicontrol Tools > \uicontrol + Options > \uicontrol Environment > \uicontrol System + (\uicontrol {Qt Design Studio} > \uicontrol Preferences > \uicontrol + Environment > \uicontrol System on \macos), and then select + \uicontrol {Enable crash reporting}. + + Since crash reports take up disk space, you may wish to remove them when + they are no longer needed. Select \uicontrol {Clear local crash reports} to + remove the crash report data. + + \image studio-crashpad-checkbox.png "Checkbox for enabling crash reporting" + + \note Crashpad is currently only supported on Windows and \macos. +*/ diff --git a/doc/qtdesignstudio/src/overviews/studio-user-feedback.qdoc b/doc/qtdesignstudio/src/overviews/studio-user-feedback.qdoc new file mode 100644 index 0000000000..463148a1c4 --- /dev/null +++ b/doc/qtdesignstudio/src/overviews/studio-user-feedback.qdoc @@ -0,0 +1,52 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! + \page studio-user-feedback.html + \previouspage collecting-usage-statistics.html + \nextpage studio-crashpad.html + + \title Collecting User Feedback + + A pop-up survey asking for your feedback will appear for some of the features + after you have been using them for some time. You will be asked to to rate + the usefulness of the feature on a scale of one to five stars. You must rate + the feature with at least one star if you wish to submit your rating. You + are also encouraged to give additional written feedback. After you select + \uicontrol Skip or \uicontrol Submit, the pop-up survey will not appear for + the same feature again. + + \image studio-feedback-popup.png "User feedback pop-up survey for Flow Editor" + + For the pop-up survey to appear, you must enable collecting statistics, and + also allow collecting \uicontrol {4 - Detailed usage statistics} in + \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry > + \uicontrol {Usage Statistics} > \uicontrol {Telemetry mode}. + You can review the submitted user feedback in + \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry > + \uicontrol {Usage Statistics} > \uicontrol {Collected Data} by selecting + \uicontrol {Qt Quick Designer Usage of views and actions} in + \uicontrol {Data sources}. +*/ diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc index 87a9904cc8..4b45b87670 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc @@ -127,7 +127,7 @@ \li Second level group layers are merged to their parent. \li Asset layers are exported as merged. \li Text layers are always exported as child items. - \li Images are exported in JPG, PNG, or SVG format, depending on your + \li Images are exported in PNG or JPG format, depending on your selection. \endlist diff --git a/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc index d789677057..8f43fca390 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-packaging.qdoc @@ -25,7 +25,7 @@ /*! \page studio-packaging.html - \previouspage creator-crashpad.html + \previouspage studio-crashpad.html \nextpage studio-developer-topics.html \title Packaging Applications diff --git a/doc/qtcreator/src/qtquick/qtdesignstudio-optimized-3d-scenes.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-optimized-3d-scenes.qdoc index 43379fdc35..43379fdc35 100644 --- a/doc/qtcreator/src/qtquick/qtdesignstudio-optimized-3d-scenes.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-optimized-3d-scenes.qdoc diff --git a/doc/qtcreator/src/qtquick/creator-logical-operators.qdocinc b/doc/qtdesignstudio/src/views/creator-logical-operators.qdocinc index 79284654a4..79284654a4 100644 --- a/doc/qtcreator/src/qtquick/creator-logical-operators.qdocinc +++ b/doc/qtdesignstudio/src/views/creator-logical-operators.qdocinc diff --git a/doc/qtcreator/src/qtquick/qtquick-adding-dynamics.qdoc b/doc/qtdesignstudio/src/views/qtquick-adding-dynamics.qdoc index 274c205c60..274c205c60 100644 --- a/doc/qtcreator/src/qtquick/qtquick-adding-dynamics.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-adding-dynamics.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-connection-editor-bindings.qdoc b/doc/qtdesignstudio/src/views/qtquick-connection-editor-bindings.qdoc index 82107b7507..82107b7507 100644 --- a/doc/qtcreator/src/qtquick/qtquick-connection-editor-bindings.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-connection-editor-bindings.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-connection-editor-properties.qdoc b/doc/qtdesignstudio/src/views/qtquick-connection-editor-properties.qdoc index c0db8d22e7..c0db8d22e7 100644 --- a/doc/qtcreator/src/qtquick/qtquick-connection-editor-properties.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-connection-editor-properties.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-connection-editor-signals.qdoc b/doc/qtdesignstudio/src/views/qtquick-connection-editor-signals.qdoc index 754066a93c..754066a93c 100644 --- a/doc/qtcreator/src/qtquick/qtquick-connection-editor-signals.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-connection-editor-signals.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-connection-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-connection-editor.qdoc index 62c9bdb543..62c9bdb543 100644 --- a/doc/qtcreator/src/qtquick/qtquick-connection-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-connection-editor.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-connection-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-connection-view.qdoc index 42a74339fb..42a74339fb 100644 --- a/doc/qtcreator/src/qtquick/qtquick-connection-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-connection-view.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-curve-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-curve-editor.qdoc index 7b34c33436..7b34c33436 100644 --- a/doc/qtcreator/src/qtquick/qtquick-curve-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-curve-editor.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-designer.qdoc b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc index 7536e8c757..7536e8c757 100644 --- a/doc/qtcreator/src/qtquick/qtquick-designer.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-easing-curve-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-easing-curve-editor.qdoc index 5a6825ca6c..5a6825ca6c 100644 --- a/doc/qtcreator/src/qtquick/qtquick-easing-curve-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-easing-curve-editor.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-form-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-form-editor.qdoc index bcd9317615..bcd9317615 100644 --- a/doc/qtcreator/src/qtquick/qtquick-form-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-form-editor.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-library.qdoc b/doc/qtdesignstudio/src/views/qtquick-library.qdoc index b1d03a72e6..b1d03a72e6 100644 --- a/doc/qtcreator/src/qtquick/qtquick-library.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-library.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-navigator.qdoc b/doc/qtdesignstudio/src/views/qtquick-navigator.qdoc index 3e50256a20..3e50256a20 100644 --- a/doc/qtcreator/src/qtquick/qtquick-navigator.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-navigator.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-properties-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-properties-view.qdoc index 9f7fb15820..9f7fb15820 100644 --- a/doc/qtcreator/src/qtquick/qtquick-properties-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-properties-view.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-properties.qdoc b/doc/qtdesignstudio/src/views/qtquick-properties.qdoc index 9b7989fb53..9b7989fb53 100644 --- a/doc/qtcreator/src/qtquick/qtquick-properties.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-properties.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-states-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-states-view.qdoc index 66179af77a..66179af77a 100644 --- a/doc/qtcreator/src/qtquick/qtquick-states-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-states-view.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-states.qdoc b/doc/qtdesignstudio/src/views/qtquick-states.qdoc index 71d4eba388..71d4eba388 100644 --- a/doc/qtcreator/src/qtquick/qtquick-states.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-states.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-text-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc index f60821ca9a..f60821ca9a 100644 --- a/doc/qtcreator/src/qtquick/qtquick-text-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-text-editor.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-timeline-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-timeline-view.qdoc index 246442def9..246442def9 100644 --- a/doc/qtcreator/src/qtquick/qtquick-timeline-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-timeline-view.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-timeline.qdoc b/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc index ab3e376872..ab3e376872 100644 --- a/doc/qtcreator/src/qtquick/qtquick-timeline.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc diff --git a/doc/qtcreator/src/qtquick/qtquick-transition-editor.qdoc b/doc/qtdesignstudio/src/views/qtquick-transition-editor.qdoc index 12ade5c3c4..12ade5c3c4 100644 --- a/doc/qtcreator/src/qtquick/qtquick-transition-editor.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-transition-editor.qdoc |
