qtquick-app-tutorial.qdoc 12.8 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (c) 2013 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
**
**
** 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
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
27
    \previouspage creator-tutorials.html
28
    \page creator-qml-application.html
29
    \nextpage creator-writing-program.html
30

31
    \title Creating a Qt Quick Application
32

33
    This tutorial uses built-in QML types and illustrates basic concepts of
34
    \l {http://qt-project.org/doc/qt-5.0/qtquick/qtquick-index.html}{Qt Quick}.
35

36
    This tutorial describes how to use \QC to implement Qt states and transitions. We use
37
    \l{http://qt-project.org/doc/qt-5.0/qtquick/animation.html}{Qt example code} to
38 39
    create an application that displays a Qt logo that moves between three rectangles on the
    page when you click them.
40 41 42 43 44 45 46 47 48 49

    \image qmldesigner-tutorial.png "States and transitions example"

    For more information about using \QMLD, see
    \l{Developing Qt Quick Applications}.

    \section1 Creating the Project

    \list 1

50
        \li Select \gui{File > New File or Project > Applications >
51
            Qt Quick Application > Choose}.
52

53
        \li In the \gui{Name} field, type \b {Transitions}.
54

55
        \li In the \gui {Create in} field, enter the path for the project files.
56 57
            For example, \c {C:\Qt\examples}, and then click \gui{Next} (on
            Windows and Linux) or \gui Continue (on Mac OS).
58

59 60 61 62 63 64 65
        \li In the \gui {Qt Quick component set} field, select
            \gui {Qt Quick 2.0}.

            \note The QML types used in this example are also supported in
            Qt Quick 1.1. To create this example application for platforms that
            run Qt 4, select \gui {Qt Quick 1.1}.

66
        \li Select \l{glossary-buildandrun-kit}{kits} for running and building your project,
67
            and then click \gui{Next}.
68

69 70
            \note Kits are listed if they have been specified in \gui Tools >
            \gui Options > \gui {Build & Run} > \gui Kits.
71

72
        \li Select \gui Next in the following dialogs to use the default
73 74
            settings.

75
        \li Review the project settings, and click \gui{Finish} (on Windows and
76
            Linux) or \gui Done (on Mac OS) to create the project.
77

78
        \li Press \key {Ctrl+R} (or \key {Cmd+R}) to run the application.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

    \endlist

    \QC generates a default QML file that you can modify to create the main view
    of the application.

    \image qmldesigner-tutorial-project.png "Transitions project in Edit mode"

    \section1 Creating the Main View

    The main view of the application displays a Qt logo in the top left corner
    of the screen and two empty rectangles.

    To use the states.png image in your application, you must copy it to the
    project directory (same subdirectory as the QML file) from the examples
    directory in the Qt installation directory. For example:
95
    \c {C:\Qt\Qt5.0.1\5.0.1\msvc2010\examples\declarative\animation\states}. The image appears
96
    in the \gui Resources pane. You can also use any other image or a QML
97
    type, instead.
98 99 100

    \list 1

101
        \li In the \gui Projects view, double-click the main.qml file
102 103
            to open it in the code editor.

104
        \li Click \gui Design to open the file in \QMLD.
105 106 107

            \image qmldesigner-tutorial-desing-mode.png "Transitions project in Design Mode"

108
        \li In the \gui Navigator pane, select \gui Text and press \key Delete to
109 110
            delete it.

111
        \li Select \gui Rectangle to edit its properties.
112 113 114 115 116

            \image qmldesigner-tutorial-page.png "Page properties"

        \list a

117
            \li In the \gui Id field, enter \e page, to be able to reference the
118 119
                rectangle from other places.

120
            \li In the \gui Colors group, \gui Rectangle field, set the color to
121 122 123 124
                #343434.

        \endlist

125
        \li In the \gui Library view, \gui Resources tab, select states.png and
126 127 128 129 130 131
            drag and drop it to the canvas.

            \image qmldesigner-tutorial-user-icon.png "Image properties"

        \list a

132
            \li In the \gui Id field, enter \e icon.
133

134
            \li In the \gui Position field, set \gui X to 10 and \gui Y to 20.
135 136 137

        \endlist

138
        \li In the \gui Library view, \gui {QML Types} tab, select \gui Rectangle,
139 140 141 142 143 144
            drag and drop it to the canvas, and edit its properties.

            \image qmldesigner-tutorial-topleftrect.png "Rectangle properties"

        \list a

145
            \li In the \gui Id field, enter \e topLeftRect.
146

147
            \li In the \gui Size field, set \gui W and \gui H to 64, for the
148 149
                rectangle size to match the image size.

150
            \li In the \gui Colors group, \gui Rectangle field, click the
151
                \inlineimage qmldesigner-transparent-button.png
152
                (\gui Transparent) button to make the rectangle transparent.
153

154
            \li In the \gui Border field, set the border color to #808080.
155

156
            \li In the \gui Rectangle group, \gui Border field, set the border
157 158 159 160 161 162
                width to 1.

                \note If the \gui Border field does not appear after you set the
                border color, try setting the border color to solid by clicking
                the
                \inlineimage qmldesigner-solid-color-button.png
163
                (\gui {Solid Color}) button.
164

165
            \li In the \gui Radius field, select 6 to create rounded corners for
166 167
                the rectangle.

168
            \li Click \gui {Layout}, and then click the top and left anchor
169 170 171 172 173
                buttons to anchor the rectangle to the top left corner of the
                page.

                \image qmldesigner-tutorial-topleftrect-layout.png "Layout tab"

174
            \li In the \gui Margin field, select 20 for the top anchor and 10
175 176 177 178
                for the left anchor.

        \endlist

179
        \li In the \gui Navigator pane, drag and drop the \gui {Mouse Area}
180
            from \e page to \e topLeftRect to make it apply only to the
181 182
            rectangle and not to the whole page.

183
        \li  Edit the \gui {Mouse Area} properties:
184 185 186

        \list a

187
            \li Click \gui {Layout}, and then click the
188
                \inlineimage qmldesigner-anchor-fill-screen.png
189 190
                (\gui {Fill to Parent}) button to anchor the mouse area to the
                rectangle.
191

192
            \li In the code editor, edit the pointer to the clicked expression
193
                in the mouse area, as illustrated by the following code
194 195 196 197 198 199 200 201 202 203 204 205 206 207
                snippet:

                \qml
                MouseArea {
                    anchors.fill: parent
                    onClicked: page.state = ''
                }
                \endqml

                The expression sets the state to the base state and returns the
                image to its initial position.

        \endlist

208 209
            The qml.main file should now look as follows:

Leena Miettinen's avatar
Leena Miettinen committed
210
            \snippet transitions/main.qml 0
211

212
        \li In the \gui Navigator pane, copy topLeftRect (by pressing
213
            \key {Ctrl+C}) and paste it to the canvas twice (by pressing
214
            \key {Ctrl+V}). \QC renames the new instances of the type
215 216
            topLeftRect1 and topLeftRect2.

217
        \li  Select topLeftRect1 and edit its properties:
218 219 220

        \list a

221
            \li In the \gui Id field, enter \e middleRightRect.
222

223
            \li In \gui {Layout}, select the vertical center anchor button and
224 225 226
                then the right anchor button to
                anchor the rectangle to the middle right margin of the screen.

227
            \li In the \gui Margin field, select 10 for the right anchor and 0
228 229
                for the vertical center anchor.

230
            \li In the code editor, add a pointer to a clicked expression to the
231
                mouse area. The following expression sets the state to
232 233 234 235 236 237 238 239
                \e State1:

                \c {onClicked: page.state = 'State1'}

                You will create State1 later.

        \endlist

240
        \li Select topLeftRect2 and edit its properties:
241 242 243

        \list a

244
            \li In the \gui Id field, enter \e bottomLeftRect.
245

246
            \li In \gui {Layout}, select the bottom and left anchor buttons to
247 248
                anchor the rectangle to the bottom left margin of the screen.

249
            \li In the \gui Margin field, select 20 for the bottom anchor and 10
250 251
                for the left anchor.

252
            \li In the code editor, add a pointer to a clicked expression to the
253
                mouse area. The following expression sets the state to
254 255 256 257 258 259
                \e State2:

                \c {onClicked: page.state = 'State2'}

                You will create State2 later.

260 261
            The qml.main file should now look as follows:

Leena Miettinen's avatar
Leena Miettinen committed
262
            \snippet transitions/main.qml 1
263

264 265
        \endlist

266
        \li Press \key {Ctrl+S} to save the changes.
267

268
        \li Press \key {Ctrl+R} to run the application.
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285

    \endlist

    \image qmldesigner-tutorial.png "States and transitions example"

    You should see the Qt logo in the top left rectangle, and two additional
    rectangles in the center right and bottom left of the screen.

    You can now create additional states to add views to the application.

    \section1 Adding Views

    In the .qml file, you already created pointers to two additional states:
    State1 and State2. To create the states:

    \list 1

286
        \li Click the empty slot in the \gui States pane to create State1.
287

288
        \li Click the empty slot in the \gui States pane to create State2.
289

290
        \li In the code editor, bind the position of the Qt logo to the
291 292 293 294 295
            rectangle to make sure that the logo is displayed within the
            rectangle when the view is scaled on different sizes of screens. Set
            expressions for the x and y properties, as illustrated by the
            following code snippet:

Leena Miettinen's avatar
Leena Miettinen committed
296
            \snippet qml/states-properties.qml states
297 298 299 300 301 302

            \image qmldesigner-tutorial-state1.png "States"

            \note When you set the expressions, drag and drop is disabled for
            the icon in \QMLD.

303
        \li Press \key {Ctrl+R} to run the application.
304 305 306 307 308 309 310 311 312 313 314 315 316 317

    \endlist

    Click the rectangles to move the Qt logo from one rectangle to another.

    \section1 Adding Animation to the View

    Add transitions to define how the properties change when the Qt logo moves
    between states. The transitions apply animations to the Qt logo. For example,
    the Qt logo bounces back when it moves to the middleRightRect and eases into
    bottomLeftRect. Add the transitions in the code editor.

    \list 1

318
        \li In the code editor, add the following code to specify that when
319 320 321
            moving to State1, the x and y coordinates of the Qt logo change
            linearly over a duration of 1 second:

Leena Miettinen's avatar
Leena Miettinen committed
322
            \snippet qml/list-of-transitions.qml first transition
323

324
        \li You can use the Qt Quick toolbar for animation to change the easing
325 326 327 328
            curve type from linear to OutBounce:

        \list a

329
            \li Click \gui NumberAnimation in the code editor to display the
330 331 332 333 334
                \inlineimage qml-toolbar-indicator.png
                icon, and then click the icon to open the toolbar:

                \image qmldesigner-tutorial-quick-toolbar.png "Qt Quick toolbar for animation"

335
            \li In the \gui Easing field, select \gui Bounce.
336

337
            \li In the \gui Subtype field, select \gui Out.
338 339 340

        \endlist

341
        \li Add the following code to specify that when moving to State2, the x
342 343 344
            and y coordinates of the Qt logo change over a duration of 2
            seconds, and an InOutQuad easing function is used:

Leena Miettinen's avatar
Leena Miettinen committed
345
            \snippet qml/list-of-transitions.qml second transition
346

347
        \li Add the following code to specify that for any other state changes,
348 349 350
            the x and y coordinates of the Qt logo change linearly over a
            duration of 200 milliseconds:

Leena Miettinen's avatar
Leena Miettinen committed
351
            \snippet qml/list-of-transitions.qml default transition
352

353
        \li Press \key {Ctrl+R} to run the application.
354 355 356 357 358

    \endlist

    Click the rectangles to view the animated transitions.

359 360 361 362
    \section1 Example Code

    When you have completed the steps, the main.qml file should look as follows:

Leena Miettinen's avatar
Leena Miettinen committed
363
    \snippet transitions/main.qml 2
364

365
*/