qtquick-app-tutorial.qdoc 12.7 KB
Newer Older
1 2 3 4
/****************************************************************************
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
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
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
28
    \previouspage creator-tutorials.html
29 30 31 32 33 34 35
    \page creator-qml-application.html
    \nextpage creator-qml-components-example.html

    \title Creating a Qt Quick Application

    \note To complete this tutorial, you must have Qt 4.7 or later installed.

36
    This tutorial uses built-in QML elements and illustrates basic concepts of
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
    \l {http://doc.qt.nokia.com/4.7/qtquick.html}{Qt Quick}.

    This tutorial describes how to use the \QC to implement the
    \l{http://doc.qt.nokia.com/4.7/declarative-animation-states.html}
    {states and transitions example application}. The example application
     displays a Qt logo that moves between three rectangles on the page when you
    click them.

    \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

54 55
        \o  Select \gui{File > New File or Project > Applications >
            Qt Quick Application (Built-in Elements) > Choose}.
56

57 58 59 60 61 62 63 64 65 66
        \o  In the \gui{Name} field, type \bold {Transitions}.

        \o  In the \gui {Create in} field, enter the path for the project files.
            For example, \c {C:\Qt\examples}, and then click \gui{Next}.

        \o  In the \gui {Application Type} dialog, select \gui {Built-in
            elements only (for all platforms)}, and then click \gui{Next}.

        \o  Select targets, and then click \gui{Next}.

Leena Miettinen's avatar
Leena Miettinen committed
67 68
            \note Targets are listed if they have been specified in \gui Tools >
            \gui Options > \gui {Build & Run} > \gui Targets.
69 70 71 72 73 74

        \o  Select \gui Next in the following dialogs to use the default
            settings.

        \o  Review the project settings, and click \gui{Finish} to create the
            project.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149

        \o  Press \key {Ctrl+R} to run the application.

    \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:
    \c {C:\QtSDK\Examples\4.7\declarative\animation\states}. The image appears
    in the \gui Resources pane. You can also use any other image or a QML
    element, instead.

    \list 1

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

        \o  Click \gui Design to open the file in \QMLD.

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

        \o  In the \gui Navigator pane, select \gui Text and press \key Delete to
            delete it.

        \o  Select \gui Rectangle to edit its properties.

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

        \list a

            \o  In the \gui Id field, enter \e page, to be able to reference the
                rectangle from other places.

            \o  In the \gui Colors group, \gui Rectangle field, set the color to
                #343434.

        \endlist

        \o  In the \gui Library view, \gui Resources tab, select states.png and
            drag and drop it to the canvas.

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

        \list a

            \o  In the \gui Id field, enter \e icon.

            \o  In the \gui Position field, set \gui X to 10 and \gui Y to 20.

        \endlist

        \o  In the \gui Library view, \gui Items tab, select \gui Rectangle,
            drag and drop it to the canvas, and edit its properties.

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

        \list a

            \o  In the \gui Id field, enter \e topLeftRect.

            \o  In the \gui Size field, set \gui W and \gui H to 64, for the
                rectangle size to match the image size.

            \o  In the \gui Colors group, \gui Rectangle field, click the
                \inlineimage qmldesigner-transparent-button.png
150
                (\gui Transparent) button to make the rectangle transparent.
151 152 153 154 155 156 157 158 159 160

            \o  In the \gui Border field, set the border color to #808080.

            \o  In the \gui Rectangle group, \gui Border field, set the border
                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
161
                (\gui {Solid Color}) button.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186

            \o  In the \gui Radius field, select 6 to create rounded corners for
                the rectangle.

            \o  Click \gui {Layout}, and then click the top and left anchor
                buttons to anchor the rectangle to the top left corner of the
                page.

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

            \o  In the \gui Margin field, select 20 for the top anchor and 10
                for the left anchor.

        \endlist

        \o  In the \gui Navigator pane, drag and drop the \gui {Mouse Area}
            element from \e page to \e topLeftRect to make it apply only to the
            rectangle and not to the whole page.

        \o Edit \gui {Mouse Area} properties:

        \list a

            \o  Click \gui {Layout}, and then click the
                \inlineimage qmldesigner-anchor-fill-screen.png
187 188
                (\gui {Fill to Parent}) button to anchor the mouse area to the
                rectangle.
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

            \o  In the code editor, edit the pointer to the clicked expression
                in the mouse area element, as illustrated by the following code
                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

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

            \snippet examples/transitions/qml/Transitions/main.qml 0

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
        \o  In the \gui Navigator pane, copy topLeftRect (by pressing
            \key {Ctrl+C}) and paste it to the canvas twice (by pressing
            \key {Ctrl+V}). \QC renames the new instances of the element
            topLeftRect1 and topLeftRect2.

        \o Select topLeftRect1 and edit its properties:

        \list a

            \o  In the \gui Id field, enter \e middleRightRect.

            \o  In \gui {Layout}, select the vertical center anchor button and
                then the right anchor button to
                anchor the rectangle to the middle right margin of the screen.

            \o  In the \gui Margin field, select 10 for the right anchor and 0
                for the vertical center anchor.

            \o  In the code editor,add a pointer to a clicked expression to the
                mouse area element. The following expression sets the state to
                \e State1:

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

                You will create State1 later.

        \endlist

        \o  Select topLeftRect2 and edit its properties:

        \list a

            \o  In the \gui Id field, enter \e bottomLeftRect.

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

            \o  In the \gui Margin field, select 20 for the bottom anchor and 10
                for the left anchor.

            \o  In the code editor, add a pointer to a clicked expression to the
                mouse area element. The following expression sets the state to
                \e State2:

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

                You will create State2 later.

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

            \snippet examples/transitions/qml/Transitions/main.qml 1

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
        \endlist

        \o  Press \key {Ctrl+S} to save the changes.

        \o  Press \key {Ctrl+R} to run the application.

    \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

        \o  Click the empty slot in the \gui States pane to create State1.

        \o  Click the empty slot in the \gui States pane to create State2.

        \o  In the code editor, bind the position of the Qt logo to the
            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:

            \snippet snippets/qml/states-properties.qml states

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

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

        \o  Press \key {Ctrl+R} to run the application.

    \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

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

            \snippet snippets/qml/list-of-transitions.qml first transition

        \o  You can use the Qt Quick toolbar for animation to change the easing
            curve type from linear to OutBounce:

        \list a

            \o  Click \gui NumberAnimation in the code editor to display the
                \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"

            \o  In the \gui Easing field, select \gui Bounce.

            \o  In the \gui Subtype field, select \gui Out.

        \endlist

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

            \snippet snippets/qml/list-of-transitions.qml second transition

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

            \snippet snippets/qml/list-of-transitions.qml default transition

        \o  Press \key {Ctrl+R} to run the application.

    \endlist

    Click the rectangles to view the animated transitions.

357 358 359 360 361 362
    \section1 Example Code

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

    \snippet examples/transitions/qml/Transitions/main.qml 2

363
*/