1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the documentation of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 /*!

    43     \page symbian-with-qt-introduction.html

    44 

    45     \title Symbian platform - Introduction to using Qt

    46     \brief An introduction to Qt for Symbian platform developers.

    47     \ingroup howto

    48     \ingroup qts60

    49 

    50     \tableofcontents

    51 

    52     \section1 Required tools

    53 

    54     See \l{Qt for Symbian platform Requirements} to see what tools are

    55     required to use Qt for Symbian platform.

    56 

    57     \section1 Installing Qt and running demos

    58 

    59     Follow the instructions found in \l{Installing Qt on the Symbian platform using binary package} to learn how

    60     to install Qt using binary package and how to build and run Qt demos.

    61 

    62     Follow the instructions found in \l{Installing Qt on the Symbian platform} to learn how to install Qt using

    63     using source package and how to build and run the Qt demos.

    64 

    65     \section1 Building your own applications

    66 

    67     If you are new to Qt development, have a look at \l{How to Learn Qt}. 

    68     In general, the difference between developing a

    69     Qt application on the Symbian platform compared to any of the other platforms supported

    70     by Qt is not that big.

    71 

    72     Once you have created a \c .pro file for your project, generate the

    73     Carbide specific \c Bld.inf and \c .mmp files this way:

    74 

    75     \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 0

    76 

    77     For more information on how to use qmake have a look at the \l

    78     {qmake Tutorial}.

    79 

    80     Now you can build the Qt for the Symbian platform application with

    81     standard build tools. By default, running \c make will produce binaries for

    82     the emulator. However, the Symbian platform comes with several alternative

    83     build targets, as shown in the table below:

    84 

    85     \table

    86     \row \o \c debug-winscw  \o Build debug binaries for the emulator (default).

    87                                 It is currently not possible to build release

    88                                 binaries for the emulator.

    89     \row \o \c debug-gcce    \o Build debug binaries for hardware using GCCE.

    90     \row \o \c release-gcce  \o Build release binaries for hardware using GCCE.

    91     \row \o \c debug-armv5   \o Build debug binaries for hardware using RVCT.

    92     \row \o \c release-armv5 \o Build release binaries for hardware using RVCT.

    93     \row \o \c run           \o Run the emulator binaries from the build directory.

    94     \row \o \c sis           \o Create signed \c .sis file for project.

    95     \endtable

    96 

    97     The following lines perform a debug build for the emulator

    98     and deploy all the needed files:

    99 

   100     \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 1

   101 

   102     To work on your project in Carbide, simply import the \c .pro file

   103     by right clicking on the project explorer and executing "Import...".

   104 

   105     \section1 Installing your own applications

   106 

   107     To install your own applications on hardware, you need signed \c .sis file.

   108     The signed \c .sis file can be created with \c make \c sis target. \c sis target

   109     is only supported for executables or projects with \c DEPLOYMENT statements.

   110     By default the \c sis target will create signed \c .sis file for last build

   111     target. For example, the following sequence will generate the needed makefiles, 

   112     build the project for \c debug-winscw and \c release-armv5, and create 

   113     self-signed \c .sis file for \c release-armv5 target:

   114 

   115     \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 2

   116 

   117     If you want to use different certificate information or override the default

   118     target for \c .sis file creation you can use the environment variables as 

   119     shown in the table below:

   120 

   121     \table

   122     \row \o \c QT_SIS_OPTIONS      \o Options accepted by \c .sis creation. 

   123                                        -i, install the package right away using PC suite.

   124                                        -c=<file>, read certificate information from a file.

   125                                        Execute the \c{createpackage.pl} script without any 

   126                                        parameters for more information about options.

   127                                        By default no otions are given.

   128     \row \o \c QT_SIS_TARGET       \o Target for which \c .sis file is created.

   129                                        Accepted values are build targets listed in 

   130                                        previous table. By default last build target.

   131     \row \o \c QT_SIS_CERTIFICATE  \o The certificate file used for signing.

   132                                        By default self-signed certificate. 

   133     \row \o \c QT_SIS_KEY          \o The certificate's private key file.

   134                                        By default key is associated to self-signed certificate. 

   135     \row \o \c QT_SIS_PASSPHRASE   \o The certificate's private key file's passphrase.

   136                                        By default empty. 

   137     \endtable    

   138 

   139     For example:

   140 

   141     \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 4        

   142 

   143     The environment variables for \c make can also be given as parameters:

   144 

   145     \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 3        

   146 

   147     If you want to install the program immediately, make sure that the device

   148     is connected to the computer in "PC Suite" mode, and run \c sis target

   149     with the \c QT_SIS_OPTIONS=-i, like this:

   150 

   151     \snippet doc/src/snippets/code/doc_src_s60-introduction.qdoc 5

   152 */