diff options
-rw-r--r-- | doc/qtcreator/images/qtquick-qml-export-dialog.png | bin | 0 -> 28280 bytes | |||
-rw-r--r-- | doc/qtcreator/src/qtcreator-toc.qdoc | 1 | ||||
-rw-r--r-- | doc/qtcreator/src/qtquick/creator-only/qtquick-app-development.qdoc | 5 | ||||
-rw-r--r-- | doc/qtcreator/src/qtquick/creator-only/qtquick-export.qdoc | 71 | ||||
-rw-r--r-- | doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc | 4 | ||||
-rw-r--r-- | doc/qtcreator/src/widgets/qtdesigner-overview.qdoc | 2 |
6 files changed, 80 insertions, 3 deletions
diff --git a/doc/qtcreator/images/qtquick-qml-export-dialog.png b/doc/qtcreator/images/qtquick-qml-export-dialog.png Binary files differnew file mode 100644 index 0000000000..d06a01e5b9 --- /dev/null +++ b/doc/qtcreator/images/qtquick-qml-export-dialog.png diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 8b3f1efa24..debfa4cda1 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -148,6 +148,7 @@ \li \l {Browsing ISO 7000 Icons} \li \l {Using QML Modules with Plugins} \li \l {Converting UI Projects to Applications} + \li \l {Exporting QML} \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 30e78fe38a..9230f3a3dd 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-development.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-development.qdoc @@ -96,6 +96,11 @@ convert them to Qt Quick Application projects that contain .pro, .cpp, and .qrc files. + \li \l {Exporting QML} + + \l{Qt Quick UI Forms}{UI forms} (ui.qml files) can be exported to + JSON metadata format and PNG assets. + \endlist */ diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-export.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-export.qdoc new file mode 100644 index 0000000000..db641f080f --- /dev/null +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-export.qdoc @@ -0,0 +1,71 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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 creator-exporting-qml.html + \previouspage quick-converting-ui-projects.html + \nextpage creator-using-qt-designer.html + + \title Exporting QML + + \l{Qt Quick UI Forms}{UI forms} (ui.qml files) can be exported to + JSON metadata format and PNG assets. + + To export the \l{Qt Quick UI Forms}{UI forms} (ui.qml files) from the + current project, select \uicontrol Build > \uicontrol {Export QML}. + + The primary use of exported metadata and assets is to generate native file + formats in content creation tools, such as Adobe Photoshop, using \QB. \QBPS + can generate PSD files by importing the metadata and assets. + + QML is exported as follows: + + \list + \li QML types inherited from \l [QML]{Item}{Item} are exported, other + types are ignored. + \li \l [QML]{Text}{Text} components are exported as metadata only + and no assets are generated. + \li \l [QML]{Rectangle}{Rectangle} and \l [QML]{Image}{Image} types + generate assets as PNG files. + \endlist + + \section1 Configuring QML Export + + You can configure the export in the \uicontrol {Export QML} dialog, which + lists the \l{Qt Quick UI Forms}{UI forms} (ui.qml files) of the current + project. + + \image qtquick-qml-export-dialog.png "QML Export Dialog" + + \list 1 + \li In the \uicontrol {Export path} field, specify the path where + the metadata file and assets are exported. + \li Deselect the \uicontrol {Export assets} check box to disable + exporting assets and only generate the metadata file. + \li In the file list, select the \l{Qt Quick UI Forms}{UI forms} + to be exported. + \li Select \uicontrol {Export} export to start the export process. + \endlist +*/ 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 00e4bb74e8..3184955033 100644 --- a/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc @@ -26,11 +26,11 @@ /*! \page quick-converting-ui-projects.html \if defined(qtdesignstudio) - \previouspage studio-importing-designs.html + \previouspage studio-importing-3d.html \nextpage quick-uis.html \else \previouspage creator-qml-modules-with-plugins.html - \nextpage creator-using-qt-designer.html + \nextpage creator-exporting-qml.html \endif \title Converting UI Projects to Applications diff --git a/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc b/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc index 915765c2b0..e2342dbe41 100644 --- a/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc +++ b/doc/qtcreator/src/widgets/qtdesigner-overview.qdoc @@ -30,7 +30,7 @@ // ********************************************************************** /*! - \previouspage quick-converting-ui-projects.html + \previouspage creator-exporting-qml.html \page creator-using-qt-designer.html \nextpage adding-plugins.html |