doc/src/symbian/symbiandev.qdoc

   1 /****************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Free Documentation License
  11 **
  12 ** Alternatively, this file may be used under the terms of the GNU Free
  13 ** Documentation License version 1.3 as published by the Free Software
  14 ** Foundation and appearing in the file included in the packaging of this
  15 ** file.
  16 **
  17 ** If you have questions regarding the use of this file, please contact
  18 ** Nokia at info@qt.nokia.com.
  19 **
  20 ****************************************************************************/
  21
  22 /*!
  23     \contentspage index.html
  24     \if defined(qcmanual)
  25     \previouspage creator-developing-maemo.html
  26     \else
  27     \previouspage sdk-gs.html
  28     \endif
  29     \page creator-developing-symbian.html
  30     \if defined(qcmanual)
  31     \nextpage creator-project-managing-sessions.html
  32     \else
  33     \nextpage creator-developing-meego.html
  34     \endif
  35
  36     \title Connecting Symbian Devices
  37
  38     When you install \QSDK, the build and run settings for Symbian devices
  39     are set up automatically in \QC. You only need to install and launch
  40     the CODA on-device debugging agent on the devices and connect the devices
  41     to the development PC.
  42
  43     Make sure that PC Suite or Ovi Suite are installed on the development PC.
  44     Connect the device to the development PC with an USB cable in
  45     PC Suite or Ovi Suite Mode. If you have not previously used the device with
  46     Ovi Suite
  47     or PC Suite, all the necessary drivers are installed automatically.
  48     This takes approximately one minute.
  49
  50     You can run Qt applications on Symbian devices if the software that Qt
  51     applications require (typically Qt, Qt Mobility, QtWebkit, and Open C) is
  52     installed on the device. On Symbian^3 and later devices, some version of Qt
  53     is pre-installed. To deploy applications to earlier devices, you can package
  54     the application with Nokia Smart Installer for Symbian to automatically
  55     install the modules that Qt applications require. For more information about
  56     which Qt modules are supported on-demand for different Symbian device
  57     models, see
  58     \l{http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian}
  59     {Nokia Smart Installer for Symbian}.
  60
  61
  62
  63     To run and debug applications on Symbian devices from \QC, you must
  64     install the CODA on-device debugging agent on the device. For more
  65     information, see
  66     \if defined(qcmanual)
  67     \l{Using On-device Debugging Agents}.
  68     \else
  69     \l{http://doc.qt.nokia.com/qtcreator/creator-developing-symbian.html#using-on-device-debugging-agents}
  70     {Using On-device Debugging Agents}.
  71     \endif
  72
  73
  74     The tool chain for building applications locally on the development PC for
  75     the \gui {Symbian Device} target is only supported on Windows.
  76     If you develop on Linux or Mac OS, you must use the Remote Compiler
  77     interface to a compilation service at Nokia Developer. You can install
  78     Remote Compiler as part of the \QSDK. For more information, see
  79     \if defined(qcmanual)
  80     \l{Building with Remote Compiler}.
  81     \else
  82     \l{http://doc.qt.nokia.com/qtcreator/creator-remote-compiler.html}
  83     {Building with Remote Compiler}.
  84     \endif
  85
  86
  87     For more information about developing applications for the Symbian
  88     platform, select \gui {Help > Index} and look for \gui {Platform Notes},
  89     or see
  90     \l{http://doc.qt.nokia.com/4.7/platform-notes-symbian.html}{Platform Notes - Symbian}.
  91
  92     \if defined(qcmanual)
  93     To run your applications in the Symbian emulator, you also need
  94     to install Carbide.c++ v2.0.0 or higher.
  95     \endif
  96
  97     \section1 Using On-device Debugging Agents
  98
  99     Support for the App TRK on-device debugging agent has been removed from
 100     \QC 2.3. Only CODA is supported. It offers the following benefits:
 101
 102     \list
 103
 104         \o  Extensive error information
 105
 106         \o  Debugging over WLAN
 107
 108         \o  Extensive information about the device
 109
 110     \endlist
 111
 112     \note CODA does not support debugging over a Bluetooth connection.
 113
 114     \section2 Installing Debugging Agents
 115
 116     CODA installation packages are delivered together with the \QSDK. On
 117     Windows, you can use \gui Start menu commands to install CODA on Symbian
 118     devices.
 119
 120     You can also download CODA from the
 121     \l{http://tools.ext.nokia.com/coda/}{CODA download server}.
 122
 123     \section1 Setting Up Qt Creator
 124
 125     When you run \QC after installing the Symbian SDK and Qt for
 126     Symbian, the installed SDKs and their corresponding Qt versions are
 127     automatically detected. For each detected Symbian SDK with Qt, a special entry
 128     is made in the Qt version management settings in \gui{Tools} >
 129     \gui{Options} > \gui{Qt4} > \gui{Qt Versions}.
 130
 131     If you manually add a Qt version for Symbian, you must
 132     also manually specify the Symbian SDK to use for this version.
 133
 134     For more information about adding Qt versions and tool chains, see
 135     \l{Setting Up Qt for Symbian Versions} and \l{Adding Tool Chains}.
 136
 137     \section1 Building and Running Applications
 138
 139     You can test your application on a device by building and running
 140     it from \QC for the \gui {Symbian Device} target.
 141
 142     \list 1
 143
 144         \o Connect the device to the development PC through a USB cable.
 145         The target selector displays a green check mark when a
 146         device is connected.
 147
 148         \image qtcreator-qt4-symbian-device-connected.png
 149
 150         The tool tip of the target selector shows more details about the actual
 151         device that will be used when you run your application.
 152
 153         \o Start the CODA debugging agent on the device.
 154
 155         \o Select \gui Options to select USB as connection type.
 156
 157         \o Click \gui Projects to edit the \gui {Build Settings} for the
 158         \gui {Symbian Device} target. Select the Qt version to use for building
 159         the application. For more information, see
 160         \l{Selecting Qt for Symbian Versions}.
 161
 162         \o Click the \gui Run button in \QC.
 163
 164     \endlist
 165
 166     \section2 Selecting Qt for Symbian Versions
 167
 168     When you select the Qt for Symbian version to build the application with, consider
 169     which version provides the application with the widest support on different
 170     Symbian platforms. The binary compatibility promise of Qt and Symbian means
 171     that applications that are built against Qt 4.6.3 also run on Qt 4.7.3.
 172     Similarly, applications that are supported on S60 5th Edition are also
 173     supported
 174     on Symbian^3. However, dependencies, such as Qt Quick or Qt Mobility API
 175     versions might restrict the choice of Qt versions that you have.
 176
 177     In general, if you use only Qt 4.6 APIs in the application, you
 178     can use \gui {Qt 4.6.3 for Symbian^1} to build it.
 179     The application is supported on both Symbian^1 and Symbian^3 devices.
 180
 181     If you use Qt Quick in the application, you can use \gui {Qt 4.7.3 for
 182     Symbian^1} to build it. The application is supported on both Symbian^1 and
 183     Symbian^3 devices.
 184
 185     \note The tool chains for developing applications for S60 3rd Edition
 186     devices have been removed from \QSDK 1.1. To develop for these early
 187     devices, use an earlier version of \QSDK.
 188
 189     If you use native Symbian APIs, you must check that they are available on
 190     the target devices. For more information about the API differences between
 191     Symbian platforms, see the \bold {Symbian
 192     Reference Documentation for Qt}, which is delivered together with \QSDK
 193     and which you can view in the \gui Help mode.
 194
 195     You can use a set of ready-made UI components called Qt Quick Components
 196     for Symbian that enforce a Nokia UI look and feel.
 197     \omit
 198     \note We recomment that you use Qt Quick Components version 1.1, because
 199     they contain usability and other improvements. The same set of devices
 200     supports both 1.0 and 1.1.
 201     \endomit
 202
 203     The following table summarizes the supported configurations for each Qt
 204     version available in \QC build settings:
 205
 206     \table
 207         \header
 208             \i  Qt Version
 209             \i  Qt Quick
 210             \i  Qt Quick Components
 211             \i  Qt Mobility Version
 212             \i  Native Symbian C++ APIs
 213             \i  OpenGL
 214         \row
 215             \i  Qt 4.6.3 for Symbian^1 (S60 5th Edition)
 216             \i  No
 217             \i  No
 218             \i  1.0.2
 219             \i  No
 220             \i  No
 221         \row
 222             \i  Qt 4.6.3 for Symbian^3
 223             \i  No
 224             \i  No
 225             \i  1.0.2
 226             \i  Yes
 227             \i  No
 228         \row
 229             \i  Qt 4.7.3 for Symbian^1
 230             \i  1.0
 231             \i  No
 232             \i  1.1.3
 233             \i  No
 234             \i  No
 235         \row
 236             \i  Qt 4.7.3 for Symbian^3 and Symbian Anna
 237             \i  1.0
 238             \i  Yes \omit 1.0 \endomit
 239             \i  1.1.3
 240             \i  Yes
 241             \i  Yes
 242         \row
 243             \i  Qt 4.7.4 for Symbian Belle
 244             \i  1.1
 245             \i  Yes \omit 1.1 \endomit
 246             \i  1.2
 247             \i  Yes
 248             \i  Yes
 249     \endtable
 250
 251 */