doc/src/platforms/wince-introduction.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2015 The Qt Company Ltd.
   4 ** Contact: http://www.qt.io/licensing/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and The Qt Company. For licensing terms
  14 ** and conditions see http://www.qt.io/terms-conditions. For further
  15 ** information use the contact form at http://www.qt.io/contact-us.
  16 **
  17 ** GNU Free Documentation License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Free
  19 ** Documentation License version 1.3 as published by the Free Software
  20 ** Foundation and appearing in the file included in the packaging of
  21 ** this file.  Please review the following information to ensure
  22 ** the GNU Free Documentation License version 1.3 requirements
  23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29     \group qtce
  30     \title Qt for Windows CE
  31     \ingroup qt-embedded
  32     \brief Documents related to Qt for Windows CE
  33
  34     Qt for Windows CE is a C++ framework for GUI and application development
  35     for embedded devices running Windows CE. It runs on a variety of processors,
  36     including ARM, Intel x86, MIPS and SH-4.
  37
  38     \table 100%
  39     \header \o Getting Started \o Reference \o Performance and Optimization
  40     \row
  41     \o
  42      \list
  43         \o \l {Qt for Windows CE Requirements}
  44         \o \l {Installing Qt for Windows CE}
  45         \o \l {Windows CE - Introduction to using Qt}{Introduction to using Qt}
  46     \endlist
  47     \o
  48     \list
  49         \o \l {Windows CE - Using shadow builds}{Using shadow builds}
  50         \o \l {Windows CE - Working with Custom SDKs}{Working with Custom SDKs}
  51     \endlist
  52     \o
  53     \list
  54         \o \l {Qt for Windows CE Hardware Accelerated Graphics}{Hardware Accelerated Graphics}
  55         \o \l {Qt Performance Tuning}
  56         \o \l {Fine-Tuning Features in Qt}
  57     \endlist
  58     \endtable
  59 */
  60
  61 /*!
  62     \page wince-with-qt-introduction.html
  63
  64     \title Windows CE - Introduction to using Qt
  65     \brief An introduction to Qt for Windows CE developers.
  66     \ingroup qtce
  67
  68     \tableofcontents
  69
  70     \section1 Required tools
  71
  72     In order to use Qt for Windows CE you need to have Visual Studio
  73     2005 or 2008 and at least one of the supported Windows
  74     CE/Mobile SDKs installed.
  75     Note, that the Visual Studio 2008 Standard Edition doesn't come
  76     with Windows CE support. You will need the Professional Edition,
  77     if you're using Visual Studio 2008.
  78
  79     We recommend the \e{Windows Mobile 5.0 SDK for Pocket PC} SDK available
  80     \l{http://www.microsoft.com/downloads/details.aspx?FamilyID=83a52af2-f524-4ec5-9155-717cbe5d25ed&amp;DisplayLang=en}{here}.
  81
  82     \section1 Installing Qt
  83
  84     Follow the instructions found in \l{Installing Qt for Windows CE}.
  85
  86     \section1 Building your own applications
  87
  88     If you are new to Qt development, have a look at \l{How to Learn Qt}
  89     and \l{Tutorials}. In general there is little or no difference in
  90     developing Qt applications for Windows CE compared to any of the
  91     other platforms supported by Qt.
  92
  93     Once you have a \c .pro file, there are two ways of building your
  94     application. You can either do it on the command line or inside of
  95     Visual Studio. To do it on the command line, simply write:
  96
  97     \snippet doc/src/snippets/code/doc_src_wince-introduction.qdoc 0
  98
  99     To build the project inside of Visual Studio, on the command line write:
 100
 101     \snippet doc/src/snippets/code/doc_src_wince-introduction.qdoc 1
 102
 103     then start Visual Studio with the generated \c .vcproj or \c .sln file and
 104     select \e{Build project}.
 105
 106     For more information on how to use qmake have a look at the \l
 107     {qmake Tutorial}.
 108
 109     \section1 Running the application
 110
 111     In order to run the application, it needs to be deployed on the
 112     Windows CE/Mobile device you want to test it for. This can either
 113     be done manually or automated using Visual Studio.
 114
 115     To do it manually, simply copy the executable, the Qt \c{.dll}
 116     files needed for the application to run, and the C-runtime library
 117     into a folder on the device, and then click on the executable to
 118     start the program. You can either use the \e Explorer found in
 119     ActiveSync or the \e{Remote File Viewer} found in Visual Studio to do
 120     this.
 121
 122     Visual Studio can do this step automatically for you as well. If you have
 123     built the project inside Visual Studio, simply select \e Deploy and then
 124     \e Debug to deploy and then run the application. You can change the
 125     device type by changing the \e{Target Device} specified in the
 126     Visual Studio toolbar.
 127
 128     Further information on deploying Qt applications for Windows can
 129     be found in the \l{Deploying an Application on Windows}
 130     {deployment document}.
 131 */