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-C29FE12C-C412-40A8-A067-27C63A519D71" xml:lang="en"><title>Choice

    13 list API</title><shortdesc>The Choice list API is used for providing a vertical list of selectable

    14 items. </shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>

    15 <fig id="GUID-00782901-3982-4482-82E0-EE5E527A82D7">

    16 <title>Choice list</title>

    17 <image href="GUID-FD52DFC5-03CD-4C7A-B118-0D5C90D99F1A_d0e76845_href.png" scale="40" placement="inline"/>

    18 </fig>

    19 <p>You can use the Choice list API in all GUI applications. It is a library

    20 API that provides an interface for constructing and using the choice list

    21 UI component.</p>

    22 <p>You can use the choice list in two ways, with or without the current selection. </p>

    23 <p>If the current selection is displayed, there is an label showing the currently

    24 selected item and an arrow button indicating that a list is available. </p>

    25 <p>If without current selection, the choice list must be created with providing

    26 a generic button to the list. This button will be used to open the list for

    27 selection. The label of the button is defined by the client application when

    28 creating the button and will not be changed by the choice list.</p>

    29 <p>For implementation information, see <xref href="GUID-845F3021-E3ED-4676-916A-75740886DCBD.dita">Providing

    30 a vertical list of selectable items</xref>.</p>

    31 <p>For the Choice list API classes and header files, see Classes

    32 and definitions.</p>

    33 <section id="GUID-A8BD46F9-8514-45AD-A413-AEF4F27B23F0"><title>Error handling</title><p>The

    34 leave mechanism of the Symbian platform environment is used to handle memory

    35 exhaustion.</p></section>

    36 </conbody><related-links>

    37 <linklist><title>Related APIs</title>

    38 <link href="GUID-F3EE1000-71A6-4D48-A30B-3D2357BF20FB.dita"><linktext>Generic button

    39 API</linktext></link>

    40 </linklist>

    41 </related-links></concept>