aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtdesignstudio/src/overviews/qtquick-export.qdoc
blob: f3042336bb8db3a5739f42caa21b246a0cbcc5a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/****************************************************************************
**
** 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 creator-exporting-qml.html
    \previouspage studio-importing-3d.html
    \nextpage qtquick-motion-design.html

    \title Exporting Components

    \note In this section, you are using advanced menu items. These are not
    visible by default. To toggle the visibility of advanced menu items, see
    \l{Customizing the Menu}.

    \l{glossary-component}{Components} contained in \l{UI Files}
    {UI files} (.ui.qml) can be exported to JSON metadata format and PNG assets.

    To export the UI files from the current project, select \uicontrol Build >
    \uicontrol {Export Components}.

    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.

    Components are exported as follows:

    \list
        \li Components (QML types) inherited from \l [QML]{Item}{Item} are
            exported, other components 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}
            components generate assets as PNG files.
    \endlist

    \section1 Configuring QML Export

    You can configure the export in the \uicontrol {Export Components} dialog,
    which lists the UI files (.ui.qml) of the current project.

    \image qtquick-qml-export-dialog.png "Export Components 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 Select the \uicontrol {Export components separately} check box to
            generate separate metadata files for each component.
        \li In the file list, select the .ui.qml files to be exported.
        \li Select \uicontrol {Export} export to start the export process.
    \endlist
*/