Files
qt-creator/doc/symbiandev.qdoc
Leena Miettinen 134a698896 Doc: Qt support on devices
Change-Id: Ida0eea494e3362a7dcf1df9dd5ac915c61af2524
Reviewed-on: http://codereview.qt-project.org/5018
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
2011-09-15 17:26:29 +02:00

329 lines
13 KiB
Plaintext

/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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 Qt Creator. You only need to install and launch
the CODA on-device debugging agent on the devices and connect the devices
to the development PC.
Make sure that PC Suite or Ovi Suite are installed on the development PC.
Connect the device to the development PC with an USB cable in
PC Suite Mode. 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.
As with every supported platform, Qt strives to maintain application
behavior and binary compatibility throughout the lifetime of the Qt 4.x
major version and on the Symbian devices that support Qt. Symbian
support in \QSDK and Ovi Store were introduced with Qt 4.6. Each Qt release
contains bug fixes that might change the API behavior and thereby affect
application compatibility.
In addition, Symbian devices have different input methods, such as different
keyboard styles or touch input, screen sizes, memory, and CPU and GPU
capabilities. Therefore, you must test applications on specific target
devices to ensure compatibility. In order to build applications that are
supported also on earlier devices, select the target in \QSDK carefully.
Generally, an earlier target (such as S60 5th Edition) is supported on a
larger number of devices than a later target (such as Symbian Belle).
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^3 and later devices, some version of Qt
is pre-installed. 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, see
\l{Qt on Symbian Devices}.
To run and debug applications on Symbian devices from Qt Creator, you must
install the CODA on-device debugging agent on the device. For more
information, see
\if defined(qcmanual)
\l{Using On-device Debugging Agents}.
\else
\l{http://doc.qt.nokia.com/qtcreator/creator-developing-symbian.html#using-on-device-debugging-agents}
{Using On-device Debugging Agents}.
\endif
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.7/platform-notes-symbian.html}{Platform Notes - Symbian}.
\if defined(qcmanual)
To run your applications in the Symbian emulator, you also need
to install Carbide.c++ v2.0.0 or higher.
\endif
\section1 Qt on Symbian Devices
Generally, when developing for Symbian^3 or later devices, you do not need
to install Qt on devices. However, you might want to upgrade or downgrade
the Qt version on a device to test your application on a particular Qt
version. Use the installation packages delivered with \QSDK
(\c {<QtSDK_install_path>\Symbian\sis}). Keep in mind that this might
replace the pre-installed Qt on the device.
\note Earlier Qt for Symbian versions, such as Qt 4.6.3 for Symbian, are
only available in the \QSDK online installer. For more information, see
\if defined(qcmanual)
\l{http://doc.qt.nokia.com/sdk/sdk-installing.html}{Installing Qt SDK}.
\else
\l{Installing Qt SDK}.
\endif
Qt is supported on different Symbian platforms as follows:
\list
\o Symbian Belle devices contain Qt 4.7.4 and Qt Mobility 1.2.1
libraries as part of device
firmware (ROM). To upgrade the Qt version, update the device
firmware. You cannot downgrade the Qt version on Belle devices.
\omit
To develop applications using Qt 4.8 or later, you can install Qt
4.8 or later libraries to Belle devices. The Qt in Belle firmware is
not overwritten. It is eclipsed by the installed Qt on the C: drive.
\endomit
\o Symbian Anna devices have Qt 4.7.3 and Qt Mobility 1.1.3
pre-installed.
\o Symbian^3 devices have Qt 4.6.3 pre-installed, but they do not have
Qt Mobility libraries pre-installed. If you use Qt Mobility features
in your application, package the application with Nokia Smart
Installer for Symbian to have the necessary dependencies installed
automatically.
\o Symbian^1 (S60 5th Edition) devices support Qt 4.6.3 and 4.7.3, but
it is not pre-installed to them. Package Qt applications with Nokia Smart
Installer for Symbian to have the latest Qt and Qt Mobility versions
that the device supports installed to the device.
\note As an exception, the Nokia C6-00 PR4 has Qt 4.7.3 and Qt
Mobility 1.1.3 preinstalled.
\o S60 3rd Edition feature pack 1 and later devices support Qt 4.6, but
it is not pre-installed to them. Package Qt applications with Nokia
Smart Installer for Symbian.
\endlist
To check the Symbian platform version of your device, see
\l{http://www.developer.nokia.com/Devices/Device_specifications/}
{Device Specifications}. The site contains information about the content
that can be published for the device to the Ovi Store (\e General section)
and the Qt libraries that are pre-installed on the device (\e API section).
If the device does not have the necessary Qt libraries pre-installed, you
can use Nokia Smart Installer for Symbian to deploy them during application
installation. Smart Installer ensures that the necessary libraries are
available in the target Symbian device before installing the actual
application. For more information about which Qt modules are supported
on-demand for different Symbian device models and how to enable Smart
Installer support in Qt applications, see
\l{http://www.developer.nokia.com/Community/Wiki/Nokia_Smart_Installer_for_Symbian}{Nokia Smart Installer for Symbian}.
\section2 Selecting Qt Versions in Qt Creator
When you select the Qt 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^3. However, dependencies, such as Qt Quick or Qt Mobility API
versions might restrict the choice of Qt versions that you have.
In general, if you use only Qt 4.6 APIs in the application, you
can use \gui {Qt 4.6.3 for Symbian^1} to build it.
The application is supported on both Symbian^1 and Symbian^3 devices.
If you use Qt Quick in the application, you can use \gui {Qt 4.7.3 for
Symbian^1} to build it. The application is supported on both Symbian^1 and
Symbian^3 devices.
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^1 and Symbian^3, 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.
\omit
\note We recomment that you use Qt Quick Components version 1.1, because
they contain usability and other improvements. The same set of devices
supports both 1.0 and 1.1.
\endomit
The following table summarizes the supported configurations for each Qt
version available in Qt Creator build settings:
\table
\header
\i Qt Version
\i Qt Quick
\i Qt Quick Components
\i Qt Mobility Version
\i Native Symbian C++ APIs
\i Open GL
\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
\i No
\row
\i Qt 4.7.3 for Symbian^1
\i 1.0
\i No
\i 1.1.3
\i No
\i No
\row
\i Qt 4.7.3 for Symbian^3
\i 1.0
\i Yes \omit 1.0 \endomit
\i 1.1.3
\i Yes
\i Yes
\row
\i Qt 4.7.4 for Symbian Belle
\i 1.1
\i Yes \omit 1.1 \endomit
\i 1.2.1
\i Yes
\i Yes
\endtable
\if defined(qcmanual)
\section1 Using On-device Debugging Agents
Support for the App TRK on-device debugging agent has been removed from
Qt Creator 2.3. Only CODA is supported. 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
CODA installation packages are delivered together with the \QSDK. On
Windows, you can use \gui Start menu commands to install CODA on Symbian
devices.
You can also download CODA from the
\l{http://tools.ext.nokia.com/coda/}{CODA download server}.
\section1 Setting Up Qt Creator
When you run Qt Creator 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{Qt4} > \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
\l{Setting Up Qt for Symbian Versions} and \l{Adding Tool Chains}.
\else
\section1 Building and Running Applications
You can test your application on a device by building and running
it from Qt Creator 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 the \gui Run button in Qt Creator.
\endlist
\endif
*/