forked from qt-creator/qt-creator
Doc: Add asset export documentation
Task-number: QDS-2729 Change-Id: I0af45f22a49cf0a8a74bc6bd9a0b0c3fd4091e1f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
BIN
doc/qtcreator/images/qtquick-qml-export-dialog.png
Normal file
BIN
doc/qtcreator/images/qtquick-qml-export-dialog.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 28 KiB |
@@ -148,6 +148,7 @@
|
|||||||
\li \l {Browsing ISO 7000 Icons}
|
\li \l {Browsing ISO 7000 Icons}
|
||||||
\li \l {Using QML Modules with Plugins}
|
\li \l {Using QML Modules with Plugins}
|
||||||
\li \l {Converting UI Projects to Applications}
|
\li \l {Converting UI Projects to Applications}
|
||||||
|
\li \l {Exporting QML}
|
||||||
\endlist
|
\endlist
|
||||||
\li \l{Developing Widget Based Applications}
|
\li \l{Developing Widget Based Applications}
|
||||||
\list
|
\list
|
||||||
|
@@ -96,6 +96,11 @@
|
|||||||
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 QML}
|
||||||
|
|
||||||
|
\l{Qt Quick UI Forms}{UI forms} (ui.qml files) can be exported to
|
||||||
|
JSON metadata format and PNG assets.
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
71
doc/qtcreator/src/qtquick/creator-only/qtquick-export.qdoc
Normal file
71
doc/qtcreator/src/qtquick/creator-only/qtquick-export.qdoc
Normal file
@@ -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
|
||||||
|
*/
|
@@ -26,11 +26,11 @@
|
|||||||
/*!
|
/*!
|
||||||
\page quick-converting-ui-projects.html
|
\page quick-converting-ui-projects.html
|
||||||
\if defined(qtdesignstudio)
|
\if defined(qtdesignstudio)
|
||||||
\previouspage studio-importing-designs.html
|
\previouspage studio-importing-3d.html
|
||||||
\nextpage quick-uis.html
|
\nextpage quick-uis.html
|
||||||
\else
|
\else
|
||||||
\previouspage creator-qml-modules-with-plugins.html
|
\previouspage creator-qml-modules-with-plugins.html
|
||||||
\nextpage creator-using-qt-designer.html
|
\nextpage creator-exporting-qml.html
|
||||||
\endif
|
\endif
|
||||||
|
|
||||||
\title Converting UI Projects to Applications
|
\title Converting UI Projects to Applications
|
||||||
|
@@ -30,7 +30,7 @@
|
|||||||
// **********************************************************************
|
// **********************************************************************
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\previouspage quick-converting-ui-projects.html
|
\previouspage creator-exporting-qml.html
|
||||||
\page creator-using-qt-designer.html
|
\page creator-using-qt-designer.html
|
||||||
\nextpage adding-plugins.html
|
\nextpage adding-plugins.html
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user