qtquick-exporting-qml.qdoc 7.52 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
**
**
** GNU Free Documentation License
**
** 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.
**
**
****************************************************************************/

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!

    \contentspage index.html
28
    \previouspage quick-screens.html
29
    \page quick-export-to-qml.html
30
    \nextpage creator-qml-modules-with-plugins.html
31 32 33 34 35

    \title Exporting Designs from Graphics Software

    You can export designs from graphics software, such as Adobe Photoshop and
    GIMP, to QML files. Each scene is converted into a single QML file with an
36 37
    Image or a Text item for each layer and saved on the development PC.
    Top-level layer groups are converted into merged QML Image types.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

    \note GIMP does not support grouping, and therefore, each layer is exported
    as an item in GIMP.

    You can open the QML file in \QC for editing. If you edit the file in Adobe
    Photoshop and export it to the same directory again, any changes you made in
    \QC are overwritten. However, you can re-export graphical assets without
    recreating the QML code.

    If you create vector graphics with other tools that have an Adobe Photoshop
    export option, such as Adobe Illustrator, you can export them first to
    Photoshop and then to QML.

    \section1 Conversion Rules

    The following rules apply to the conversions:

    \list

57
        \li Layer names are used as item names. Spaces and hash marks (#) are
58
            replaced with underscore characters to create valid ids for the
59
            items.
60

61
        \li Layer styles, such as drop shadows, are converted to images.
62

63
        \li Offset, size, ordering and opacity are preserved.
64

65 66
        \li Text layers are converted to Text items, unless you specify that
            they be converted to Image items.
67

68
        \li Hidden layers can be exported, and their visibility is set to
69 70
            hidden.

71
        \li PNG images are copied to the images subirectory.
72 73 74 75 76 77 78 79 80 81

    \endlist

    \section1 Preparing Files for Conversion

    To create QML files that are easy to use, prepare the Adobe Photoshop or
    GIMP designs for exporting, as follows:

    \list

82
        \li To minimize the number of items, minimize the number of layers or
83
            use top-level layer groups, because each layer or layer group is
84
            exported as a Text or Image item.
85

86 87
        \li To make sure that all related items are exported to the same
            item, use top-level layer groups.
88

89
        \li To determine that some layers are not exported, hide them, and
90 91
            deselect the \gui {Export hidden} check box during exporting.

92
        \li To make it easier to find the layers and layer groups after
93 94
            exporting them, use descriptive names for them.

95
        \li To make sure that image dimensions are preserved during export,
96 97 98 99
            create at least one fully filled layer (which can be hidden), such
            as a background layer. If the export script does not find a fully
            filled layer, it resizes all images to the size of the canvas.

100
        \li To prevent errors during export, make sure that the layers are not
101 102
            locked. Locked layers cannot be exported.

103
        \li To avoid unexpected results, do not use Blending Mode effects. They
104 105 106 107 108 109 110 111 112 113 114 115 116
            are not exported.

    \endlist

    \section1 Exporting from Adobe Photoshop to QML

    \image qml-export-photoshop.png

    The script has been tested to work on Adobe Photoshop CS 4 and 5, but it
    might also work on other versions.

    \list 1

117
        \li Download the export script, \e{Export QML.jx}, from
118 119 120 121 122 123
            \l{http://qt.gitorious.org/qt-labs/photoshop-qmlexporter/trees/master}
            {Gitorious}.

            \note Read the README.txt file in the repository for latest
            information about the script.

124
        \li Double-click the export script to add the export command to the
125 126 127 128
            \gui Scripts menu. You can also copy the script file to the Adobe
            Photoshop scripts directory (typically, \c{\Presets\Scripts} in the
            Photoshop installation directory).

129
        \li In Adobe Photoshop, choose \gui {File > Scripts > Export to QML} to
130 131
            export the scene to a QML file.

132
        \li In the \gui {Export Document to QML} dialog, enter a name and
133 134
            location for the QML file.

135
        \li Select the \gui {Rasterize text} check box to export text layers as
136
            images, not as Text items.
137

138
        \li Select the \gui {Group layers} check box to export each top-level
139
            group as a merged QML Image item.
140

141
        \li Select the \gui {Export hidden} check box to export hidden layers
142 143
            and to set their visibility property to hidden.

144
        \li Deselect the \gui {Export QML} check box if you have modified the
145 146
            QML document in \QC, but still want to re-export graphical assets.

147
        \li Click \gui Export.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

    \endlist

    The QML file is saved to the location that you specified. In \QC, choose
    \gui {File > Open File or Project} to open the QML file.

    \note Existing files are replaced without warning.

    \section1 Exporting from GIMP to QML

    \image qml-export-gimp.png

    The script has been tested to work on GIMP 2. You can download GIMP 2 from
    \l{http://www.gimp.org/downloads/}{GIMP Downloads}.

    To use the export script on Microsoft Windows, you also need to install the
    GIMP Python extension (Python, PyCairo, PyGobject, PyGTK). However, GIMP is
    not officially supported on Windows, so we cannot guarantee that this will
    work.

    \list 1

170
        \li On Microsoft Windows, you must first add Python support to your GIMP
171 172 173 174
            installation, as instructed in
            \l {http://www.gimpusers.com/tutorials/install-python-for-gimp-2-6-windows}
            {Tutorial: Installing Python for GIMP 2.6 (Windows)}.

175
        \li Download the export script, \e qmlexporter.py, from
176 177 178 179 180 181
            \l{http://qt.gitorious.org/qt-labs/gimp-qmlexporter/trees/master}
            {Gitorious}.

            \note Read the INSTALL.txt in the repository for latest information
            about the script.

182
        \li Copy the export script to the plug-ins directory in the GIMP
183 184
            installation directory.

185
        \li Check the properties of the file to make sure that it is executable.
186 187 188

            On Linux, run the following command: \c {chmod u+rx}

189
        \li Restart GIMP to have the export command added to the \gui File menu.
190

191
        \li Choose \gui {File > Export to QML} to export the design to a QML
192 193
            file.

194
        \li In the \gui {Export Layers to a QML Document} dialog, enter a name
195 196 197 198 199 200 201 202 203 204
            and location for the QML file, and click \gui Export.

    \endlist

    The QML file is saved to the location that you specified. In \QC, choose
    \gui {File > Open File or Project} to open the QML file.

    \note Existing files are replaced without warning.

*/