Doc: Remove info about Qt Quick Designer plugin from Qt Creator Manual

Fixes: QTCREATORBUG-26321
Change-Id: I8738cbdc56d6469a4d133b17741871787e0cba9f
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
This commit is contained in:
Leena Miettinen
2021-10-05 15:50:41 +02:00
parent badc1f8551
commit 73fa76f776
91 changed files with 336 additions and 542 deletions

View File

@@ -12,11 +12,9 @@ ignorewords += \
MinGW MinGW
headerdirs = headerdirs =
sourcedirs = ../src \ sourcedirs = ../src
../../qtdesignstudio/src/qtquick3d-editor
imagedirs = ../images \ imagedirs = ../images \
../../qtdesignstudio/images \
../../../src/libs/qmleditorwidgets/images \ ../../../src/libs/qmleditorwidgets/images \
../../../src/libs/utils/images \ ../../../src/libs/utils/images \
../../../src/plugins/android/images \ ../../../src/plugins/android/images \
@@ -27,14 +25,6 @@ imagedirs = ../images \
../../../src/plugins/diffeditor/images \ ../../../src/plugins/diffeditor/images \
../../../src/plugins/help/images \ ../../../src/plugins/help/images \
../../../src/plugins/projectexplorer/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/scxmleditor/common/images \
../../../src/plugins/texteditor/images \ ../../../src/plugins/texteditor/images \
../../../src/plugins/valgrind/images \ ../../../src/plugins/valgrind/images \
@@ -50,17 +40,12 @@ depends += qtandroidextras\
qtcmake \ qtcmake \
qtcore \ qtcore \
qtqml \ qtqml \
qtqmlmodels \
qtquick \ qtquick \
qmake \ qmake \
qtdesigner \ qtdesigner \
qtdoc \ qtdoc \
qtgraphicaleffects \
qtgui \ qtgui \
qthelp \ qthelp \
qtquick3d \
qtquickcontrols \
qtquickextras \
qtquicktimeline \ qtquicktimeline \
qtlinguist \ qtlinguist \
qtscxml \ qtscxml \

View File

@@ -1,12 +1,2 @@
{HTML.extraimages,qhp.QtCreator.extraFiles} += \ {HTML.extraimages,qhp.QtCreator.extraFiles} += \
images/commercial.png \ 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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

View File

@@ -244,7 +244,12 @@
You can change property values temporarily, without editing the source, and You can change property values temporarily, without editing the source, and
view the results in the running application. You can change the property 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 \section1 Applying QML Changes at Runtime

View File

@@ -433,45 +433,44 @@
\row \row
\li M203 \li M203
\li Warning \li Warning
\li Imperative code is not supported in the Design mode \li Imperative code is not supported in \QDS
\li \li
\row \row
\li M204 \li M204
\li Warning \li Warning
\li This QML type is not supported in the Design mode \li This QML type is not supported in \QDS
\li \li
\row \row
\li M205 \li M205
\li Warning \li Warning
\li Reference to parent QML type cannot be resolved correctly by the \li Reference to parent QML type cannot be resolved correctly by \QDS
Design mode
\li \li
\row \row
\li M206 \li M206
\li Warning \li Warning
\li This visual property binding cannot be evaluated in the local \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 \li
\row \row
\li M207 \li M207
\li Warning \li Warning
\li Design mode only supports states in the root QML type \li \QDS only supports states in the root QML type
\li \li
\row \row
\li M208 \li M208
\li Error \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 \li
\row \row
\li M209 \li M209
\li Error \li Error
\li This type (type name) is not supported as a root element in the \li This type (type name) is not supported as a root element in
Design mode. \QDS.
\li \li
\row \row
@@ -691,8 +690,7 @@
instead of Qt Quick 2}. instead of Qt Quick 2}.
You can see the error message when you move the mouse pointer over code that 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 \QC underlines in the code editor or when you open a QML file in \QDS.
mode.
To reset the code model, select \uicontrol Tools > \uicontrol {QML/JS} > To reset the code model, select \uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Reset Code Model}. \uicontrol {Reset Code Model}.
@@ -700,7 +698,7 @@
\if defined(qtcreator) \if defined(qtcreator)
If this does not help, try changing the QML emulation layer to the one that 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 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 \endif
\section1 Inspecting QML and JavaScript \section1 Inspecting QML and JavaScript

View File

@@ -869,8 +869,10 @@
\image qtcreator-move-component-into-separate-file.png \image qtcreator-move-component-into-separate-file.png
\li QML type name. This action is also available in the \li QML type name.
\uicontrol {Form Editor} in the Design mode. \if defined(qtdesignstudio)
This action is also available in \l {Form Editor}.
\endif
\row \row
\li Split Initializer \li Split Initializer
\li Reformats a one-line type into a multi-line type. For example, \li Reformats a one-line type into a multi-line type. For example,

View File

@@ -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
*/

View File

@@ -101,3 +101,11 @@
\externalpage http://developer.android.com/guide/components/fundamentals.html \externalpage http://developer.android.com/guide/components/fundamentals.html
\title Android Application Fundamentals \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
*/

View File

@@ -580,10 +580,11 @@
\endtable \endtable
\endif \endif
\if defined(qtdesignstudio)
\section2 Design Mode Keyboard Shortcuts \section2 Design Mode Keyboard Shortcuts
You can use the following keyboard shortcuts when editing QML files in the You can use the following keyboard shortcuts when editing QML files in the
Design mode. \uicontrol Design mode.
\table \table
\header \header
@@ -603,6 +604,7 @@
\li Toggle right sidebar \li Toggle right sidebar
\li Ctrl+Alt+Shift+0 \li Ctrl+Alt+Shift+0
\endtable \endtable
\endif
\section2 Debugging Keyboard Shortcuts \section2 Debugging Keyboard Shortcuts

View File

@@ -104,7 +104,7 @@
\b {What should I do when \QC complains about missing OpenGL support?} \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 relies on OpenGL API for drawing. Unfortunately, the use of OpenGL can cause
problems, especially in remote setups and with outdated drivers. In these problems, especially in remote setups and with outdated drivers. In these
cases, \QC displays OpenGL-related error messages on the console or records cases, \QC displays OpenGL-related error messages on the console or records

View File

@@ -84,7 +84,7 @@
\page collecting-usage-statistics.html \page collecting-usage-statistics.html
\previouspage creator-telemetry.html \previouspage creator-telemetry.html
\if defined(qtdesignstudio) \if defined(qtdesignstudio)
\nextpage collecting-user-feedback.html \nextpage studio-user-feedback.html
\else \else
\nextpage creator-help-overview.html \nextpage creator-help-overview.html
\endif \endif
@@ -116,67 +116,3 @@
that you do not want to transmit to the backend storage. that you do not want to transmit to the backend storage.
\endlist \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.
*/

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -40,7 +40,6 @@
\l{http://qt.io/licensing/}{Qt license}: \l{http://qt.io/licensing/}{Qt license}:
\list \list
\li \l{Browsing ISO 7000 Icons} in the Design mode
\li \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Developing for \li \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Developing for
embedded devices} embedded devices}
\li \l{http://doc.qt.io/qtcreator/creator-overview-qtasam.html} \li \l{http://doc.qt.io/qtcreator/creator-overview-qtasam.html}

View File

@@ -38,16 +38,19 @@
\image front-ui.png \image front-ui.png
\QC provides integrated visual editors for designing Qt Quick and \QC provides an integrated visual editor designing widget-based applications
widget-based applications in the Design mode. The integration in the \uicontrol Design mode. The integration includes project management
includes project management and code completion. and code completion.
You can develop Qt Quick applications in the \uicontrol Edit mode or use
a separate visual editor, \QDS.
\list \list
\li \l{Developing Qt Quick Applications} \li \l{Developing Qt Quick Applications}
You can use wizards to create Qt Quick projects containing 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} \li \l{Developing Widget Based Applications}

View File

@@ -143,15 +143,4 @@
{GCC Bugzilla - Bug 44731}. {GCC Bugzilla - Bug 44731}.
\endlist \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
*/ */

View File

@@ -64,10 +64,8 @@
\l{Managing Projects}. \l{Managing Projects}.
\li \b {\l{Designing User Interfaces}} \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 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 If you need a traditional user interface that is clearly
structured and enforces a platform look and feel, you can use structured and enforces a platform look and feel, you can use
the integrated \QD. For more information, see the integrated \QD. For more information, see

View File

@@ -46,7 +46,7 @@
\li \l{Creating a Qt Quick Application} \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} \li \l{Creating a Qt Widget Based Application}

View File

@@ -103,105 +103,9 @@
\li \l{Developing Qt Quick Applications} \li \l{Developing Qt Quick Applications}
\list \list
\li \l {Creating Qt Quick Projects} \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 {Converting UI Projects to Applications}
\li \l {UI Files}
\li \l {Using QML Modules with Plugins}
\endlist \endlist
\li \l{Developing Widget Based Applications} \li \l{Developing Widget Based Applications}
\list \list

View File

@@ -36,64 +36,31 @@
\title Developing Qt Quick Applications \title Developing Qt Quick Applications
You can develop Qt Quick applications in the \uicontrol Edit mode or use
a separate visual editor, \QDS.
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}.
For more information about using \QDS, see \l{Qt Design Studio Manual}.
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.
The following topics describe Qt Quick application development using \QC:
\list \list
\li \l {Creating Qt Quick Projects} \li \l {Creating Qt Quick Projects}
You can use wizards to create 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}
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.
\li \l{Motion Design}
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.
\endlist
For more information, watch a video that shows how to perform the tasks
above:
\youtube pEETxSxYazg
\section1 Related Topics
\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}
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.
\li \l {Converting UI Projects to Applications} \li \l {Converting UI Projects to Applications}
Qt Quick UI projects (.qmlproject) are useful for creating user Qt Quick UI projects (.qmlproject) are useful for creating user
@@ -101,11 +68,15 @@
convert them to Qt Quick Application projects that contain .pro, convert them to Qt Quick Application projects that contain .pro,
.cpp, and .qrc files. .cpp, and .qrc files.
\li \l {Exporting Components} \li \l {UI Files}
\l{UI Files}{UI files} (.ui.qml) can be exported to If you switch between \QC and \QDS or cooperate with designers on
JSON metadata format and PNG assets. 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.
\li \l{Using QML Modules with Plugins}
You can load C++ plugins for QML to simulate data.
\endlist \endlist
*/ */

View File

@@ -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
*/

View File

@@ -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.
*/

View File

@@ -29,8 +29,8 @@
\previouspage studio-porting-projects.html \previouspage studio-porting-projects.html
\nextpage creator-editor-external.html \nextpage creator-editor-external.html
\else \else
\previouspage qtquick-iso-icon-browser.html \previouspage quick-projects.html
\nextpage creator-using-qt-designer.html \nextpage creator-quick-ui-forms.html
\endif \endif
\title Converting UI Projects to Applications \title Converting UI Projects to Applications
@@ -47,8 +47,7 @@
\endlist \endlist
For more information about integrating QML and C++, see For more information about integrating QML and C++, see
\l{https://doc.qt.io/qt/qtqml-cppintegration-overview.html} \l{Overview - QML and C++ Integration}.
{Overview - QML and C++ Integration}.
You can use a Qt Creator wizard template to create a Qt Quick application 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 that is built using the qmake build system and then copy the source files
@@ -61,10 +60,8 @@
compiling them into the binary. compiling them into the binary.
The wizard automatically adds the \c QML_IMPORT_PATH option to the project The wizard automatically adds the \c QML_IMPORT_PATH option to the project
file for specifying the required file for specifying the required \l{QML Import Path}{QML import path}. The
\l{https://doc.qt.io/qt/qtqml-syntax-imports.html#qml-import-path} path is only needed if more than one subdirectory contains QML files.
{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 Then you can use the \l QQuickView class in the main C++ source file to
show the main QML file when the application starts. show the main QML file when the application starts.
@@ -90,8 +87,8 @@
\list 1 \list 1
\li Select \uicontrol File > \uicontrol {New File or Project} > \li Select \uicontrol File > \uicontrol {New File or Project} >
\uicontrol {Application (Qt Quick)} > \uicontrol {Application (Qt)} > \uicontrol {Qt Quick Application} >
\uicontrol {Qt Quick Application - Empty} > \uicontrol Choose. \uicontrol Choose.
\li In the \uicontrol {Build system} field, select \l qmake as the build \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 system to use for building and running the project, and then select
\uicontrol Next (or \uicontrol Continue on \macos). \uicontrol Next (or \uicontrol Continue on \macos).
@@ -151,9 +148,13 @@
\section1 Adding Custom Fonts \section1 Adding Custom Fonts
To \l{Using Custom Fonts}{use custom fonts} from the Qt Quick UI project, \if defined(qtdesignstudio)
call the QFontDatabase::addApplicationFont() function from the \e {main.cpp} To \l{Using Custom Fonts}{use custom fonts}
file. \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 \section1 Adding Qt Quick Designer Components to Qt Installations

View File

@@ -30,6 +30,12 @@
\title Previewing on Desktop \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: To preview the currently active QML file on the desktop:
\list \list
@@ -39,24 +45,21 @@
\li Press \key {Alt+P}. \li Press \key {Alt+P}.
\endlist \endlist
\if defined(qtcreator)
\image qtcreator-live-preview.png
\else
\image studio-live-preview.png \image studio-live-preview.png
\endif \endif
To preview any QML file that belongs to the project, right-click the project 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} 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. 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 The frames-per-second (FPS) refresh rate of animations is displayed in the
\uicontrol FPS field. \uicontrol FPS field.
\if defined(qtdesignstudio)
\section1 Selecting the Preview Tool \section1 Selecting the Preview Tool
By default, the QML runtime is used for previewing. To use some By default, the QML runtime is used for previewing. To use some

View File

@@ -25,7 +25,11 @@
/*! /*!
\page creator-live-preview.html \page creator-live-preview.html
\if defined(qtdesignstudio)
\previouspage quick-states.html \previouspage quick-states.html
\else
\previouspage creator-building-running.html
\endif
\nextpage creator-live-preview-desktop.html \nextpage creator-live-preview-desktop.html
\title Validating with Target Hardware \title Validating with Target Hardware
@@ -53,8 +57,7 @@
\list \list
\li \l{Previewing on Desktop} \li \l{Previewing on Desktop}
You can preview individual QML files or the whole UI in the You can preview individual QML files or the whole UI.
Design mode.
\li \l{Previewing on Devices} \li \l{Previewing on Devices}
\if defined(qtcreator) \if defined(qtcreator)

View File

@@ -33,10 +33,11 @@
\page creator-qml-modules-with-plugins.html \page creator-qml-modules-with-plugins.html
\if defined(qtdesignstudio) \if defined(qtdesignstudio)
\previouspage studio-simulink.html \previouspage studio-simulink.html
\else
\previouspage qtquick-placeholder-data.html
\endif
\nextpage qtquick-adding-dynamics.html \nextpage qtquick-adding-dynamics.html
\else
\previouspage creator-quick-ui-forms.html
\nextpage creator-using-qt-designer.html
\endif
\title Using QML Modules with Plugins \title Using QML Modules with Plugins
@@ -45,7 +46,12 @@
the contained components, and therefore, the modules must provide extra type the contained components, and therefore, the modules must provide extra type
information for code completion and the semantic checks to work correctly. 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 \list 1
@@ -69,29 +75,27 @@
\li Create a directory named \c designer in your module directory. \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 \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. components in the \uicontrol Components tab in \uicontrol Library.
\endif
Use a metainfo file delivered with Qt, such as Use a metainfo file delivered with Qt, such as
\c qtquickcontrols2.metainfo, as an example. \c qtquickcontrols2.metainfo, as an example.
\if defined(qtcreator) \if defined(qtcreator)
\li Import the module into the project, as instructed in \li Import the module into the project, as instructed in
\l {Importing QML Modules}. \l {Importing QML Modules}.
\endlist
\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.
\else \else
\li Build your module using the same Qt version and compiler as \QDS. \li Build your module using the same Qt version and compiler as \QDS.
For more information, see \l {Running QML Modules in Design Mode}. 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 Your module should now appear in the \uicontrol Components tab in
\uicontrol Library. Your components should appear in a subsection of \uicontrol Library. Your components should appear in a subsection of
the \uicontrol Components tab if a valid \c .metainfo file is in place. the \uicontrol Components tab if a valid \c .metainfo file is in place.
\endif
\if defined(qtcreator) \if defined(qtcreator)
\section1 Registering QML Types \section1 Registering QML Types
@@ -105,9 +109,6 @@
complain about unknown types. However, this works only when the source code complain about unknown types. However, this works only when the source code
is available, and therefore, you must explicitly generate type information is available, and therefore, you must explicitly generate type information
for QML modules with plugins before distributing them. 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 \endif
\section1 Generating qmltypes Files \section1 Generating qmltypes Files
@@ -168,26 +169,16 @@
\endcode \endcode
The import path affects all the targets built by the CMake project. The import path affects all the targets built by the CMake project.
\endif
\else
\section1 Running QML Modules in Design Mode \section1 Running QML Modules in Design Mode
A QML emulation layer (also called QML Puppet) is used in the Design mode to A QML emulation layer (also called QML Puppet) is used in the
render and preview images and to collect data. To be able to render custom components \uicontrol Design mode to render and preview images and to collect
correctly from QML modules, the emulation layer must be built with the same data. To be able to render custom components correctly from QML modules,
Qt version and compiler as the 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 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. 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)}. For example: \c {Based on Qt 5.15.2 (MSVC 2019, 64 bit)}.
@@ -195,21 +186,20 @@
On macOS, select \uicontrol {Qt Design Studio} > On macOS, select \uicontrol {Qt Design Studio} >
\uicontrol {About Qt Design Studio} to see something like: \uicontrol {About Qt Design Studio} to see something like:
\c {Based on Qt 5.15.2 (Clang 10.0 (Apple), 64 bit)}. \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 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 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 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 If you want to use a different module in the \uicontrol Design mode
application for example to mockup C++ items, then you can use \c{QML_DESIGNER_IMPORT_PATH} 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 in the \c{.pro} file (for qmake projects), or declare and set the property
\c qmlDesignerImportPaths in your product (for Qbs projects). \c qmlDesignerImportPaths in your product (for Qbs projects).
Modules in the import paths defined in \c{QML_DESIGNER_IMPORT_PATH} will be 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}. For an example, see \l {Qt Quick Controls - Contact List}.
\endif
*/ */

View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2018 The Qt Company Ltd. ** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -56,7 +56,13 @@
\section1 Previewing Images \section1 Previewing Images
The Qt Quick Toolbar for images allows you to edit the properties of 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, You can scale and tile the images, replace them with other images,
preview them, and change the image margins. preview them, and change the image margins.
@@ -97,8 +103,12 @@
\section1 Editing Rectangles \section1 Editing Rectangles
The Qt Quick Toolbar for rectangles allows you to edit the properties of 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 \if defined(qtdesignstudio)
colors and add gradients. \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" \image qml-toolbar-rectangle.png "Qt Quick Toolbar for rectangles"

View File

@@ -35,18 +35,24 @@
\previouspage studio-advanced.html \previouspage studio-advanced.html
\nextpage creator-telemetry.html \nextpage creator-telemetry.html
\else \else
\previouspage qtquick-annotations.html \previouspage quick-converting-ui-projects.html
\nextpage qtquick-prototyping.html \nextpage creator-qml-modules-with-plugins.html
\endif \endif
\title UI Files \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}. 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 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 \list
\li JavaScript blocks \li JavaScript blocks
@@ -162,6 +168,7 @@
For more information about using the methods, see For more information about using the methods, see
\l{https://doc.qt.io/qt/qml-qtqml-qt.html}{Qt QML Methods}. \l{https://doc.qt.io/qt/qml-qtqml-qt.html}{Qt QML Methods}.
\if defined(qtdesignstudio)
\section1 Using UI Files \section1 Using UI Files
You can edit the UI files in the \l {Form Editor} and 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 implementation of a component in the .qml file, right-click the
component and select \uicontrol {Go to Implementation} in the component and select \uicontrol {Go to Implementation} in the
context menu. context menu.
\endif
*/ */

View File

@@ -33,6 +33,7 @@
If you cannot see a file in the \l Projects view, switch to the 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. \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 The following image displays the \uicontrol {File System} view in the
\uicontrol Design mode: \uicontrol Design mode:
@@ -89,6 +90,7 @@
\endlist \endlist
\section1 File System View in Sidebar \section1 File System View in Sidebar
\endif
In the \uicontrol Edit and \uicontrol Debug mode, the In the \uicontrol Edit and \uicontrol Debug mode, the
\uicontrol {File System} view is displayed in the \l{Working with Sidebars} \uicontrol {File System} view is displayed in the \l{Working with Sidebars}

View File

@@ -35,8 +35,13 @@
\image qtcreator-open-documents-view.png "Open Documents view" \image qtcreator-open-documents-view.png "Open Documents view"
You can use the context menu to apply some of the functions also available 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} in the \uicontrol File menu
{File System} view to the file that is selected in the view. \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: In addition, you can:

View File

@@ -40,6 +40,7 @@
the build system structure of the project and lists all files that the build system structure of the project and lists all files that
are part of the project. are part of the project.
\if defined(qtdesignstudio)
The following image displays the \uicontrol Projects view in the The following image displays the \uicontrol Projects view in the
\uicontrol Design mode: \uicontrol Design mode:
@@ -65,14 +66,6 @@
configuration files. configuration files.
\endlist \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 \section1 Projects View Context Menu
The \uicontrol Projects view contains context menus for managing projects, The \uicontrol Projects view contains context menus for managing projects,
@@ -114,6 +107,7 @@
the \l {File System} view. the \l {File System} view.
\section1 Projects View in Sidebar \section1 Projects View in Sidebar
\endif
In the \uicontrol Edit and \uicontrol Debug mode, the \uicontrol Projects In the \uicontrol Edit and \uicontrol Debug mode, the \uicontrol Projects
view is displayed in the \l{Working with Sidebars}{sidebar}. It has a view is displayed in the \l{Working with Sidebars}{sidebar}. It has a

View File

@@ -292,11 +292,6 @@
\uicontrol View > \uicontrol {Mode Selector Style} > \uicontrol Hidden. \uicontrol View > \uicontrol {Mode Selector Style} > \uicontrol Hidden.
To only show icons on the mode selector, select the \uicontrol {Icons Only} To only show icons on the mode selector, select the \uicontrol {Icons Only}
style. 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 \endif
You can use \QC in the following modes: You can use \QC in the following modes:

View File

@@ -70,10 +70,10 @@
files are included in the current file and which files include files are included in the current file and which files include
the current file. the current file.
\endlist \endlist
\endif \else
For more information about views that are only available when editing QML 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 The additional options in a particular view are described in the following
sections. sections.

View File

@@ -28,12 +28,12 @@
\section1 Qt Designer Integration Questions \section1 Qt Designer Integration Questions
\b {Why are custom widgets not loaded in Design mode even though it \b {Why are custom widgets not loaded in the \uicontrol Design mode even though
works in standalone Qt Designer?} 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 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}. For more information, see \l{Adding Qt Designer Plugins}.

View File

@@ -30,7 +30,7 @@
// ********************************************************************** // **********************************************************************
/*! /*!
\previouspage creator-exporting-qml.html \previouspage creator-qml-modules-with-plugins.html
\page creator-using-qt-designer.html \page creator-using-qt-designer.html
\nextpage adding-plugins.html \nextpage adding-plugins.html

View File

@@ -30,14 +30,11 @@
\title Simulating Complex Experiences \title Simulating Complex Experiences
\QDS enables you to connect UIs to different forms of data from various \QDS enables you to connect UIs to different forms of data from various
sources, such as QML-based data models, JavaScript files, and backend sources, such as QML-based data models, JavaScript files, and backend
services. services. You can also connect your UI to Simulink to load live data from a
\if definded(qtdesignstudio)
You can also connect your UI to Simulink to load live data from a
Simulink simulation. Simulink simulation.
\endif
\list \list
\li \l{Loading Placeholder Data} \li \l{Loading Placeholder Data}
@@ -46,7 +43,6 @@
you can test grid, list, or path views, even though you don't you can test grid, list, or path views, even though you don't
have access to real data. have access to real data.
\if defined(qtdesignstudio)
\li \l{Simulating Application Logic} \li \l{Simulating Application Logic}
You can use JavaScript to generate mock data for your UI. 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 Use the Simulink connector to connect a Simulink Simulation Model to
your UI. Simulink is a MATLAB-based graphical programming environment your UI. Simulink is a MATLAB-based graphical programming environment
for modeling, simulating, and analyzing multi-domain dynamic systems. for modeling, simulating, and analyzing multi-domain dynamic systems.
\endif
\li \l{Using QML Modules with Plugins} \li \l{Using QML Modules with Plugins}

View File

@@ -25,17 +25,12 @@
/*! /*!
\page qtquick-placeholder-data.html \page qtquick-placeholder-data.html
\previouspage studio-simulation-overview.html \previouspage studio-simulation-overview.html
\if defined(qtdesignstudio)
\nextpage studio-javascript.html \nextpage studio-javascript.html
\else
\nextpage creator-qml-modules-with-plugins.html
\endif
\title Loading Placeholder Data \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 a Grid View, List View, or Path View component, the ListModel and
the delegate component are added automatically. the delegate component are added automatically.

View File

@@ -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.
*/

View File

@@ -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}.
*/

View File

@@ -25,7 +25,7 @@
/*! /*!
\page studio-packaging.html \page studio-packaging.html
\previouspage creator-crashpad.html \previouspage studio-crashpad.html
\nextpage studio-developer-topics.html \nextpage studio-developer-topics.html
\title Packaging Applications \title Packaging Applications