creator-mobile-app-tutorial.qdoc 10.1 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
**
** This file is part of Qt Creator
**
**
** 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.
// **********************************************************************

/*!
26
    \contentspage {Qt Creator Manual}
27
    \previouspage creator-writing-program.html
28
    \page creator-mobile-app-tutorial.html
Leena Miettinen's avatar
Leena Miettinen committed
29
    \nextpage {Using Qt Quick UI Forms}
30

31
    \title Creating a Mobile Application
32

33 34 35
    This tutorial describes developing Qt Quick applications for Android and iOS
    devices using Qt Quick Controls.
    We use \QC to implement a Qt Quick application
36 37 38 39 40
    that accelerates an SVG (Scalable Vector Graphics) image based on the
    changing accelerometer values.

    \image creator_android_tutorial_ex_app.png

41 42
    \section1 Setting up the Development Environment

43 44 45 46 47
    To be able to build and run the application on a mobile device, you must
    set up the development environment for the device platform and configure a
    connection between \QC and the mobile device.

    To develop for Android  devices, you must download and install
48
    the latest Android NDK and SDK, and update the SDK to get the API and tools
49
    needed for development. In addition, you must install the
50 51 52 53 54
    Java SE Development Kit (JDK) and Apache Ant. After you have installed all
    these tools, you must specify the paths to them in \QC.
    For detailed instructions, see \l{Qt for Android} and
    \l{Connecting Android Devices}.

55 56 57 58 59
    To develop for iOS devices, you must install Xcode and use it to configure
    a device. For this, you need an Apple developer account and iOS Developer
    Program certificate that you receive from Apple. For more information, see
    \l{Connecting iOS Devices}.

60 61 62 63
    \section1 Creating the Project

    \list 1

64 65
        \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
            \uicontrol {Qt Quick Application} > \uicontrol Choose.
66

67
        \li In the \uicontrol{Name} field, type \b{accelbubble}.
68

69 70 71
        \li In the \uicontrol {Create in} field, enter the path for the project files.
            For example, \c {C:\Qt\examples}, and then click \uicontrol{Next} (or
            \uicontrol Continue on OS X).
72

73 74
        \li In the \uicontrol {Qt Quick component set} field, select
            \uicontrol {Qt Quick Controls 1.1}.
75

76
        \li Select \l{glossary-buildandrun-kit}{kits} for Android ARM and iPhone
77
            OS, and click \uicontrol{Next}.
78

79 80 81 82
            \note Kits are listed if they have been specified in \uicontrol Tools >
            \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux)
            or in \uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} >
            \uicontrol Kits (on OS X).
83

84
        \li Select \uicontrol Next in the following dialogs to use the default
85 86
            settings.

87
        \li Review the project settings, and click \uicontrol{Finish} (or \uicontrol Done on
88
            OS X).
89

90 91
    \endlist

92 93
    \QC generates a default QML file that you can modify to create the main view
    of the application.
94 95 96 97 98 99

    \section1 Creating the Main View

    The main view of the application displays an SVG bubble image at the center
    of the main window.

100 101 102 103 104
    To use the Bluebubble.svg used by the Qt Sensors example, Accel Bubble, in
    your project, 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:\Qt\Qt5.2.0\5.2.0\msvc2010\examples\sensors\accelbubble\content}.
105
    The image appears in \uicontrol Resources. You can also use any other
106
    image or a QML type, instead.
107 108 109

    \list 1

110
        \li In the \uicontrol Projects view, double-click the main.qml file
111
            to open it in the code editor.
112

113 114 115
        \li Modify the properties of the ApplicationWindow type to specify the
            application name, give the ApplicationWindow an id, and to set it
            visible, as illustrated by the following code snippet:
116

117
            \quotefromfile accelbubble/main.qml
118
            \skipto ApplicationWindow
119
            \printuntil visible
120 121 122
            \skipto /^\}/
            \printuntil }

123
        \li Click \uicontrol Design to open the file in \QMLD.
124

125
        \li In the \uicontrol Navigator, select \uicontrol Label and press \key Delete
126
            to delete it.
127

128
        \li In \uicontrol Library > \uicontrol Resources, select Bluebubble.svg
129
            and drag and drop it to the canvas.
130

131
        \li In the \uicontrol Properties pane, \uicontrol Id field, enter \e bubble to be
132
            able to reference the image from other places.
133

134 135 136
        \li In the code editor, add the following new properties to the image to
            position the image at the center of ApplicationWindow when the
            application starts:
137

138
            \quotefromfile accelbubble/main.qml
139
            \skipto Image
140
            \printuntil bubble.width
141

142 143
         \li Set the x and y position of the image based on the new
            properties:
144 145

            \dots
146 147
            \printuntil centerY
            \skipto /^\}/
148 149 150
            \printuntil }
    \endlist

151
    Here is how the accelbubble.qml file looks after you made the changes:
152

153
    \quotefromfile accelbubble/main.qml
154
    \skipto import QtQuick
155
    \printuntil 1.1
156 157 158 159
    \codeline
    \skipto ApplicationWindow
    \printuntil true
    \skipto Image
160 161 162
    \printuntil y:
    \skipto /^\}/
    \printuntil }
163 164 165 166 167 168 169

    \section1 Moving the Bubble

    Now that the visual elements are in place, let us move the bubble based on
    Accelerometer sensor values.

    \list 1
170
        \li Add the following import statement to main.qml:
171

172 173 174
            \code
            import QtSensors 5.0
            \endcode
175

176
        \li Add the \l{Accelerometer} type with the necessary properties:
177

178
            \quotefromfile accelbubble/main.qml
179 180 181 182 183 184 185 186 187
            \skipto Accelerometer
            \printuntil true
            \skipto }
            \printuntil }

        \li Add the following JavaScript functions that calculate the
            x and y position of the bubble based on the current Accelerometer
            values:

188 189 190 191
            \quotefromfile accelbubble/main.qml
            \skipto function
            \printuntil Math.atan(x
            \printuntil }
192 193 194 195 196

        \li Add the following JavaScript code for \a onReadingChanged signal of
            Accelerometer type to make the bubble move when the Accelerometer
            values change:

197 198 199
            \quotefromfile accelbubble/main.qml
            \skipto onReadingChanged
            \printuntil }
200

201 202 203
            We want to ensure that the position of the bubble is always within
            the bounds of the screen. If the Accelerometer returns not a number
            (NaN), the value is ignored and the bubble position is not updated.
204 205 206
        \li Add SmoothedAnimation behavior on the \a x and \a y properties of
            the bubble to make its movement look smoother.

207 208 209 210 211
            \quotefromfile accelbubble/main.qml
            \skipto Behavior
            \printuntil x
            \printuntil }
            \printuntil }
212 213
     \endlist

214 215 216 217 218 219 220 221 222 223 224 225 226
     \section1 Locking Device Orientation

     The device display is rotated by default when the device orientation
     changes between portrait and landscape. For this example, it would be
     better for the screen orientation to be fixed.

    To lock the orientation to portrait or landscape on Android, specify it in
    an AndroidManifest.xml that you can generate in \QC. For more information,
    see \l{Editing Manifest Files}.

    On iOS, you can lock the device orientation in a Info.plist file that you
    specify in the .pro file as the value of the QMAKE_INFO_PLIST variable.

227
    \section1 Adding Dependencies
228

229 230
    Update the accelbubble.pro file with the following library dependency
    information:
231

232 233 234
    \code
    QT += quick sensors svg xml
    \endcode
235

236 237 238 239 240 241 242 243 244 245 246 247
    On iOS, you must link to the above libraries statically, by adding the
    plugin names explicitly as values of the QTPLUGIN variable. Specify a
    qmake scope for iOS builds (which can also contain the QMAKE_INFO_PLIST
    variable):

    \code
    ios {
    QTPLUGIN += qsvg qsvgicon qtsensors_ios
    QMAKE_INFO_PLIST = Info.plist
    }
    \endcode

248
    After adding the dependencies, select \uicontrol Build > \uicontrol {Run qmake} to apply
249 250 251 252 253 254 255 256 257
    the changes to the Makefile of the project.

    \section1 Adding Resources

    You need to add the Bluebubble.svg image file to the application resources
    for deployment to mobile devices:

    \list 1

258
        \li In the \uicontrol Projects view, double-click the qml.qrc file to open it
259 260
            in the resource editor.

261
        \li Select \uicontrol Add to add Bluebubble.svg.
262 263 264

    \endlist

265
    \section1 Running the Application
266

267
    The application is complete and ready to be deployed to a device:
268

269
    \list 1
270

271 272
        \li Enable \e{USB Debugging} on the Android device or \e{developer mode}
            on the iOS device.
273

274
        \li Connect the device to the development PC.
275 276 277 278

    If you are using a device running Android v4.2.2, it should prompt you to
    verify the connection to allow USB debugging from the PC it is connected
    to. To avoid such prompts every time you connect the device, check
279
    "Always allow from the computer" and select \uicontrol OK.
280

281
        \li To run the application on the device, press \key {Ctrl+R}.
282

283
    \endlist
284

285
    \section1 Example Code
286

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

289 290 291
    \quotefromfile accelbubble/main.qml
    \skipto import
    \printuntil /^\}/
292 293

*/