Symbian3/PDK/Source/GUID-36751DD3-448E-5B94-B6BC-76EF6DE97C75.dita
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 02 Jul 2010 12:51:36 +0100
changeset 11 5072524fcc79
parent 5 f345bda72bc4
child 12 80ef3a206772
permissions -rw-r--r--
Fixing terminology

<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
<!-- Initial Contributors:
    Nokia Corporation - initial contribution.
Contributors: 
-->
<!DOCTYPE concept
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="GUID-36751DD3-448E-5B94-B6BC-76EF6DE97C75" xml:lang="en"><title>EmbApp:
An Embedded Application</title><prolog><metadata><keywords/></metadata></prolog><conbody>
<section><title>Download</title> <p>Click on the following link to download
the example: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-87d4afef-01ce-4913-8d1e-f8c3f896109c.zip" scope="external"> embedded.zip</xref></p><p>Click: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-87d4afef-01ce-4913-8d1e-f8c3f896109c.html" scope="peer">browse</xref> to view the example code. </p> </section>
<section><title>Description</title> <p>This example comprises an embedded
application (<filepath>embedded.dll</filepath>) and the stub (<filepath>embedded.exe</filepath>).
The stub is essentially an empty executable that launches the embedded application,
which is wrapped up as an ECOM plug-in. <filepath>Embedded.dll</filepath> builds
on the <xref href="GUID-1D7BD70F-40A3-53FF-8150-A9CAFA4D01D8.dita">minimal</xref> UI
application. </p> <p>The application is defined in the registration file (<filepath>embedded_reg.rss</filepath>)
as an embedded and/or a stand-alone application: </p> <codeblock id="GUID-234F184B-21E6-5590-BC19-A60629F73580" xml:space="preserve">embeddability=KAppEmbeddable;</codeblock> <p>and <codeph>KAppEmbeddable</codeph> is defined in <filepath>appinfo.rh</filepath>. </p> </section>
<section><title>Class Summary</title><p><xref href="GUID-E36E2F07-09E7-32BC-BB83-14DF9232E7D9.dita"><apiname>CEikApplication</apiname></xref></p><p><xref href="GUID-B33A8A56-D1BE-3E3D-B5AC-F644A5C764DB.dita"><apiname>CEikDocument</apiname></xref></p><p><xref href="GUID-1185F595-0488-3E93-8D60-6B3A1A3AC32E.dita"><apiname>CEikAppUi</apiname></xref></p><p><xref href="GUID-B06F99BD-F032-3B87-AB26-5DD6EBE8C160.dita"><apiname>CCoeControl</apiname></xref></p></section>
<section><title>Launching an application</title> <p> <codeph>EikStart::RunApplication(KAppEmbeddableUid)</codeph> launches
the ECOM plugin using <codeph>KAppEmbeddableUid</codeph>. </p> </section>

<section><title>Build</title> <p>The <xref href="GUID-3100800B-B2F7-50EF-BD4C-3C345ECCB2A5.dita">Symbian
build process</xref> describes how to build an application. Using ECom plug-ins
as a mechanism for delivering embeddable applications is discussed in <xref href="GUID-3CAD7211-2164-5F93-9EA7-7167E1C14012.dita">How to port guide: apps to
exes</xref>. </p> <p>The <filepath>EmbApp</filepath> example builds a plugin
called <filepath>embedded.dll</filepath> and an executable called <filepath>embedded.exe</filepath> in
the standard location (<filepath>\epoc32\release\winscw\</filepath> <i>&lt;build_variant&gt;</i> for
CodeWarrior). Either launch the executable itself, or launch the emulator
and then select the <filepath>embedded</filepath> application from the Emulator's
extras bar. </p> </section>
</conbody></concept>