1 <?xml version="1.0" encoding="utf-8"?>

     2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->

     3 <!-- This component and the accompanying materials are made available under the terms of the License 

     4 "Eclipse Public License v1.0" which accompanies this distribution, 

     5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->

     6 <!-- Initial Contributors:

     7     Nokia Corporation - initial contribution.

     8 Contributors: 

     9 -->

    10 <!DOCTYPE concept

    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">

    12 <concept id="GUID-CBB00F6A-CBA7-4872-B0A1-A86A863725F5" xml:lang="en"><title>Precompiled

    13 resource values available from the Symbian platform</title><prolog><metadata><keywords/></metadata></prolog><conbody>

    14 <p>The Symbian platform provides a generated resource header file that

    15 contains symbolic IDs to resources in the Symbian platform for use in your

    16 code. The file with the symbolic IDs is the <parmname>avkon.rsg</parmname> file

    17 and it is in the <parmname>./epoc32/include</parmname> folder. The file contains

    18 commonly used resource structures for your resource file declarations.</p>

    19 <p>A common example is the <parmname>R_AVKON_SOFTKEYS_OPTIONS_EXIT</parmname> symbolic

    20 ID, which maps to the <parmname>CBA</parmname> resource that results in the

    21 softkeys <parmname>Options</parmname> and <parmname>Exit</parmname>. The <parmname>Options</parmname> softkey

    22 is bound to a command that results in the application framework opening the

    23 options menu based on the <parmname>MENU_PANE</parmname> resource. The <parmname>Exit</parmname> softkey

    24 returns the <parmname>EAknSoftkeyExit</parmname> command, which would need

    25 to be handled in the appropriate place for <xref href="GUID-4941C035-C359-4968-9BD5-31F44EE5F810.dita">command

    26 handling</xref> in your application architecture. </p>

    27 <note>

    28 <p>The Symbian platform enumerations are in the <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/avkon_8hrh.html" format="application/java-archive"><parmname>avkon.hrh</parmname></xref> file,

    29 which is in the <parmname>/epoc32/include</parmname> folder. </p>

    30 </note>

    31 <p>In general, you can map the commands returned from the CBA options by

    32 comparing the names of the symbolic IDs to the symbolic names in the enumerated

    33 list.</p>

    34 <p>Other symbolic IDs for other purposes are also available in the <parmname>avkon.rsg</parmname> file.</p>

    35 <p>When the precompiled resources fit the needs of your application, you

    36 can use them to access already existing resource structures. </p>

    37 <p>For examples of how these symbolic IDs are used, see</p>

    38 <ul>

    39 <li><p><xref href="GUID-A3AF142B-F9DF-43FD-9D3F-788A74D0C575.dita">Using

    40 precompiled CBA button resources</xref></p>

    41 </li>

    42 </ul>

    43 </conbody></concept>