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-A3AF142B-F9DF-43FD-9D3F-788A74D0C575" xml:lang="en"><title>Using

    13 precompiled CBA button resources</title><prolog><metadata><keywords/></metadata></prolog><conbody>

    14 <p>To define <xref href="GUID-0F8D0399-58CD-4EB6-82DF-75D6BE5B0A84.dita#GUID-0F8D0399-58CD-4EB6-82DF-75D6BE5B0A84/GUID-5F749184-C804-41FC-BA81-038783BDC967">resources</xref> for

    15 a precompiled <xref href="GUID-A4F3738C-CBFD-4151-9132-26FE05966715.dita">CBA button</xref> option:</p>

    16 <ol>

    17 <li id="GUID-5225D60A-D8D2-4FB0-B938-F2FAE91F4955"><p>Determine

    18 the CBA button requirements of your application.</p></li>

    19 <li id="GUID-C7B01995-16A6-45AD-8616-FFB290870BC2"><p>Declare <parmname>cba

    20 = precompiled symbolic ID in avkon.hrh</parmname> in the <xref href="GUID-23A60DE7-B72D-41BD-9F1E-882D31A7E3C7.dita"><parmname>EIK_APP_INFO</parmname></xref> or <xref href="GUID-B238952B-1691-49F4-B8B9-9F755011A7DD.dita"><parmname>AVKON_VIEW</parmname></xref> resource.

    21 where <parmname>precompiled symbolic ID in avkon.hrh</parmname> is an <xref href="GUID-CBB00F6A-CBA7-4872-B0A1-A86A863725F5.dita">enumerated value</xref> in

    22 the <parmname>avkon.hrh</parmname> file delivered with the SDK and in the <parmname>./Epoc32/include</parmname> folder.

    23 An example is as follows:</p>

    24 <itemgroup>

    25 <codeblock id="GUID-6D73CAC8-36C6-4AC1-B5A3-E53B97F9B6FF" xml:space="preserve">RESOURCE EIK_APP_INFO

    26     {

    27     menubar = r_value_menubar;

    28     cba = R_AVKON_SOFTKEYS_OPTIONS_EXIT;

    29     }</codeblock>

    30 <p>In this case, <parmname>Options</parmname> and <parmname>Exit</parmname> appear

    31 above the softkeys at runtime.</p>

    32 <p>The <parmname>Options</parmname> softkey is bound to a command that

    33 results in the application framework opening the options menu based on the <parmname>MENU_BAR</parmname> resource.

    34 The <parmname>Exit</parmname> softkey returns the <parmname>EAknSoftkeyExit</parmname> command,

    35 which would need to be handled in the appropriate place for command handling

    36 in your application architecture. Note that the Symbian platform enumerations

    37 are in the <parmname>avkon.hrh</parmname> file. In general, you can map the

    38 commands returned from the CBA options by comparing the names of the symbolic

    39 IDs to the symbolic names in the enumerated list.</p>

    40 </itemgroup>

    41 </li>

    42 <li id="GUID-EBEB81FE-4A51-4E22-A815-BA49CB7E3E03"><p>If required, <xref href="GUID-4941C035-C359-4968-9BD5-31F44EE5F810.dita">handle the commands</xref> caused

    43 by the selection of a CBA option in your application.</p></li>

    44 </ol>

    45 </conbody></concept>