summaryrefslogtreecommitdiff
path: root/doc/src/symbian/symbiandev.qdoc
blob: c7ac388ecf7c6e0dbf6ca003393c9b92f546f2c8 (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
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
150
151
152
153
154
155
156
157
158
159
160
161
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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
258
259
260
261
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
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/

/*!
    \contentspage index.html
    \if defined(qcmanual)
    \previouspage creator-developing-maemo.html
    \else
    \previouspage sdk-gs.html
    \endif
    \page creator-developing-symbian.html
    \if defined(qcmanual)
    \nextpage creator-project-managing-sessions.html
    \else
    \nextpage creator-developing-meego.html
    \endif

    \title Connecting Symbian Devices

    When you install \QSDK, the build and run settings for Symbian devices
    are set up automatically in \QC. You only need to install and launch
    the \l{Using On-device Debugging Agents}{CODA on-device debugging agent}
    on the devices and connect the devices to the development PC.

    Make sure that \l{http://www.nokia.com/ovisuite}{Ovi Suite} or
    \l{http://www.nokia.com/pcsuite}{PC Suite} is installed on the development PC.
    Connect the device to the development PC with an USB cable in
    Ovi Suite or PC Suite Mode. This setting is in the device USB settings.
    If you have not previously used the device with Ovi Suite
    or PC Suite, all the necessary drivers are installed automatically.
    This takes approximately one minute.

    You can run Qt applications on Symbian devices if the software that Qt
    applications require (typically Qt, Qt Mobility, QtWebkit, and Open C) is
    installed on the device. On Symbian Anna and later devices, some version of Qt
    is pre-installed. For more information, see
    \l{http://developer.qt.nokia.com/wiki/Support_for_Symbian#4ebe3e7733f9c23c76ac25559fc814a1}
    {Device Configurations}.

    To deploy applications to earlier devices, you can package
    the application with Nokia Smart Installer for Symbian to automatically
    install the modules that Qt applications require. For more information about
    which Qt modules are supported on-demand for different Symbian device
    models, see
    \l{http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian}
    {Nokia Smart Installer for Symbian}.

    The tool chain for building applications locally on the development PC for
    the \gui {Symbian Device} target is only supported on Windows.
    If you develop on Linux or Mac OS, you must use the Remote Compiler
    interface to a compilation service at Nokia Developer. You can install
    Remote Compiler as part of the \QSDK. For more information, see
    \if defined(qcmanual)
    \l{Building with Remote Compiler}.
    \else
    \l{http://doc.qt.nokia.com/qtcreator/creator-remote-compiler.html}
    {Building with Remote Compiler}.
    \endif


    For more information about developing applications for the Symbian
    platform, select \gui {Help > Index} and look for \gui {Platform Notes},
    or see
    \l{http://doc.qt.nokia.com/4.8/platform-notes-symbian.html}
    {Platform Notes - Symbian}.

    \section1 Using On-device Debugging Agents

    To run and debug applications on Symbian devices from \QC, you must
    install the CODA on-device debugging agent on the device.

    Support for the App TRK on-device debugging agent has been removed from
    \QC 2.3. Only CODA is supported Qt SDK 1.1.3 onward. It offers the following
    benefits:

    \list

        \o  Extensive error information

        \o  Debugging over WLAN

        \o  Extensive information about the device

    \endlist

    \note CODA does not support debugging over a Bluetooth connection.

    \section2 Installing Debugging Agents

    The CODA installation package is delivered together with \QSDK. You can
    find it in the \QSDK installation folder in the
    \c{\Symbian\sis\<target>\CODA} folder. On Windows, you can use \gui Start
    menu commands to install CODA on Symbian devices.

    \section1 Setting Up Qt Creator

    When you run \QC after installing the Symbian SDK and Qt for
    Symbian, the installed SDKs and their corresponding Qt versions are
    automatically detected. For each detected Symbian SDK with Qt, a special entry
    is made in the Qt version management settings in \gui{Tools} >
    \gui{Options} > \gui{Build & Run} > \gui{Qt Versions}.

    If you manually add a Qt version for Symbian, you must
    also manually specify the Symbian SDK to use for this version.

    For more information about adding Qt versions and tool chains, see
    \if defined(qcmanual)
    \l{Setting Up Qt for Symbian Versions} and \l{Adding Tool Chains}.
    \else
    \l{http://doc.qt.nokia.com/qtcreator/creator-project-qmake.html#setting-up-qt-for-symbian-versions}
    {Setting Up Qt for Symbian Versions} and
    \l{http://doc.qt.nokia.com/qtcreator/creator-tool-chains.html}
    {Adding Tool Chains}.
    \endif


    \section1 Building and Running Applications

    You can test your application on a device by building and running
    it from \QC for the \gui {Symbian Device} target.

    \list 1

        \o Connect the device to the development PC through a USB cable.
        The target selector displays a green check mark when a
        device is connected.

        \image qtcreator-qt4-symbian-device-connected.png

        The tool tip of the target selector shows more details about the actual
        device that will be used when you run your application.

        \o Start the CODA debugging agent on the device.

        \o Select \gui Options to select USB as connection type.

        \o Click \gui Projects to edit the \gui {Build Settings} for the
        \gui {Symbian Device} target. Select the Qt version to use for building
        the application. For more information, see
        \l{Selecting Qt for Symbian Versions}.

        \o Click the \gui Run button in \QC.

    \endlist

    \section2 Selecting Qt for Symbian Versions

    When you select the Qt for Symbian version to build the application with, consider
    which version provides the application with the widest support on different
    Symbian platforms. The binary compatibility promise of Qt and Symbian means
    that applications that are built against Qt 4.6.3 also run on Qt 4.7.3.
    Similarly, applications that are supported on S60 5th Edition are also
    supported
    on Symbian Anna and Belle. However, dependencies, such as Qt Quick or Qt Mobility API
    versions might restrict the choice of Qt versions that you have.

    If you use Qt Quick in the application, you can use \gui {S60 5th Edition
    Qt 4.7.3} to build it. The application is supported on both S60 5th Edition
    and Symbian Anna and Belle devices. However, if you only target Symbian
    Anna and Belle, you can use the state of art Qt in the \gui {Symbian Anna
    Qt 4.7.4} target to build the application. This allows you to re-use the
    application for MeeGo Harmattan devices.

    If you want to use the native Symbian Belle APIs and make sure that the
    application created for earlier Symbian platforms work on Belle as well,
    use \gui {Symbian Belle Qt 4.7.4} to build them. You cannot run such
    applications on Symbian Anna or earlier Symbian platforms.

    \note The \QSDK only contains the latest tool chains available for
    developing applications for a particular Symbian platform. The Qt 4.6.3 for
    Symbian and Qt 4.7.3 for Symbian^3 and Symbian Anna targets have been
    removed from \QSDK 1.1.4. To develop for those targets, use \QSDK 1.1.2.

    If you use native Symbian APIs, you must check that they are available on
    the target devices. For more information about the API differences between
    Symbian platforms, see the \bold {Symbian
    Reference Documentation for Qt}, which is delivered together with \QSDK
    and which you can view in the \gui Help mode.

    You can use a set of ready-made UI components called Qt Quick Components
    for Symbian that enforce a Nokia UI look and feel. \QSDK updates the Qt
    Quick Components to version 1.1 that contains usability and other
    improvements. All devices that support Qt Quick Components for Symbian
    support version 1.1.

    The following table summarizes the supported configurations for each Qt
    version available in \QC build settings:

    \table
        \header
            \i  Qt Version
            \i  Qt Quick
            \i  Qt Quick Components
            \i  Qt Mobility Version
            \i  Native Symbian C++ APIs
            \i  Qt OpenGL Support
        \row
            \i  S60 5th Edition Qt 4.7.3 (online installer only)
            \i  1.0
            \i  No
            \i  1.1.3
            \i  No
            \i  No
        \row
            \i  Symbian Anna Qt 4.7.4
            \i  1.1
            \i  1.1
            \i  1.2
            \i  Yes (Symbian Anna APIs)
            \i  Yes
        \row
            \i  Symbian Belle Qt 4.7.4
            \i  1.1
            \i  1.1
            \i  1.2
            \i  Yes (Symbian Belle APIs)
            \i  Yes
    \endtable

    \section2 Developing Applications Using Qt 4.6.3 or Qt 4.7.3 for Symbian

    S60 3rd Edition devices support only Qt 4.6.3, not Qt 4.7 or later. Further,
    support for the App TRK on-device debugging agent has been removed from
    \QC 2.3. Only CODA is supported from Qt SDK 1.1.3 onward, and CODA does not
    support S60 3rd Edition. Therefore, you can no longer run and debug
    applications from \QC on S60 3rd Edition devices.

    The tool chains for developing applications using Qt 4.6.3 for Symbian
    and Qt 4.7.3 for Symbian^ 3 and Symbian Anna have been removed from \QSDK
    1.1.4. To develop such applications,
    \l{http://qt.nokia.com/downloads/downloads}
    {download and use \QSDK version 1.1.2} instead. It contains Qt 4.6.3 for
    Symbian and Qt 4.7.4 for Symbian support for Symbian devices with
    the Application TRK debug agent.

    \note The \QSDK 1.1.2 and \QSDK 1.1.4 do not play well together. On Windows
    and Linux, you must use separate user accounts to install them or install
    them on separate development PCs.

    \note Do not update \QSDK 1.1.2 with the \QSDK update tool, because
    the updater removes App TRK support and the older targets.

    In general, if you use only Qt 4.6 APIs in the application, you
    can use \gui {S60 5th Edition Qt 4.6.3} to build it. The application is
    supported on both S60 5th Edition and later devices.

    The following table summarizes the supported configurations for each Qt
    version available in \QC build settings if you installed \QSDK 1.1.2.

    \table
        \header
            \i  Qt Version
            \i  Qt Quick
            \i  Qt Quick Components
            \i  Qt Mobility Version
            \i  Native Symbian C++ APIs
            \i  Qt OpenGL Support
        \row
            \i  Qt 4.6.3 for Symbian^1 (S60 5th Edition)
            \i  No
            \i  No
            \i  1.0.2
            \i  No
            \i  No
        \row
            \i  Qt 4.6.3 for Symbian^3
            \i  No
            \i  No
            \i  1.0.2
            \i  Yes (Symbian^3 APIs)
            \i  No
        \row
            \i  Qt 4.7.3 for Symbian^3 and Symbian Anna
            \i  1.0
            \i  1.0
            \i  1.1.3
            \i  Yes (Symbian Anna APIs)
            \i  Yes
    \endtable

    \section1 Advanced Development with Symbian SDK

    For normal Qt application development, \QSDK provides all you need even if
    the application needs native Symbian OS API access.

    However, for more advanced Symbian application development, Nokia provides
    the \l{http://www.developer.nokia.com/carbide_cpp}{Carbide C++ IDE} and
    \l{http://www.developer.nokia.com/Resources/Tools_and_downloads/Other/Symbian_SDKs/}
    {Symbian C++ SDKs}. You can use them also for Qt application development.
    For example, these SDKs provide Symbian device emulators that are built
    mostly from the software that the actual devices are running. Therefore,
    they provide much closer emulation of the device than Qt Simulator.

*/