Symbian3/SDK/Source/GUID-0822B030-E776-4BD5-B9C9-23D3821BCE1F.dita
changeset 7 51a74ef9ed63
child 8 ae94777fff8f
equal deleted inserted replaced
6:43e37759235e 7:51a74ef9ed63
       
     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-0822B030-E776-4BD5-B9C9-23D3821BCE1F" xml:lang="en"><title>Selection
       
    13 list</title><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    14 <p>A selection list is a common means of displaying and accessing data in
       
    15 applications. When a selection list is displayed, the application is typically
       
    16 in a permanent state, which means that the user can leave the application,
       
    17 open another application, and later return to the same state. Selection lists
       
    18 are displayed in the main pane.</p>
       
    19 <p>Typically, the user can open items in a selection list, leading into another,
       
    20 more detailed view of the item within the application. In addition to browsing
       
    21 and selecting items, other functions are available in the Options menu (see <xref href="GUID-BFEEECCA-190B-4DDE-8A04-4FE918BE8690.dita">Options menu</xref>).</p>
       
    22 <p>The usage of the Selection key in selection lists deserves special attention.
       
    23 Depending on the case, it can do the following actions:</p>
       
    24 <ul>
       
    25 <li><p>Selects the item in focus. This should happen whenever it is assumed
       
    26 that it is clear to the user what happens. Selecting can mean:</p><ul>
       
    27 <li><p>Opening an item, such as a folder or a date in Calendar, leading to
       
    28 a detailed view.</p></li>
       
    29 <li><p>Executing a command when the focused item is a command.</p></li>
       
    30 </ul></li>
       
    31 <li><p>Opens the context sensitive Options menu. This should only happen when
       
    32 the user cannot be assumed to know what happens if the Selection key is pressed.
       
    33 The menu should contain only high-priority options associated with the item
       
    34 in focus, not general items such as Settings, Help, or Exit. The maximum amount
       
    35 of options in the context sensitive Options menu is four.</p></li>
       
    36 </ul>
       
    37 <p>The two types of Selection key actions should not be mixed within one list;
       
    38 one or the other should happen for every item in the list.</p>
       
    39 <fig id="GUID-010C51B9-5D2A-4DD5-A1DA-67A30CD132FD">
       
    40 <title>Select action opens a view</title>
       
    41 <image href="GUID-B7E55764-C137-4877-9083-63ACEAF30BE5_d0e61475_href.png" placement="inline"/>
       
    42 </fig>
       
    43 <fig id="GUID-5DD10CF4-6E68-4C81-81D8-1CA45CD674C4">
       
    44 <title>Select action performs a command</title>
       
    45 <image href="GUID-06B287CD-C19A-4CAC-8378-5563C552448B_d0e61483_href.png" placement="inline"/>
       
    46 </fig>
       
    47 <fig id="GUID-B8275C0A-50B9-4A48-AC20-8E2B84F23F8B">
       
    48 <title>Context sensitive Options menu opened with the Selection key</title>
       
    49 <image href="GUID-26778399-0105-413F-A39D-535A3BF5EBE2_d0e61491_href.png" placement="inline"/>
       
    50 </fig>
       
    51 <p>The keypad functions for selection lists are as follows:</p>
       
    52 <table id="GUID-2AF81DA9-8C20-47AE-87DE-8252CC1DAF59"><title>Default key events
       
    53 in selection list</title>
       
    54 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
       
    55 <tbody>
       
    56 <row>
       
    57 <entry><p>Arrow up / down</p></entry>
       
    58 <entry><p>Moves the focus in the list.</p></entry>
       
    59 </row>
       
    60 <row>
       
    61 <entry><p>Arrow left / right</p></entry>
       
    62 <entry><p>May be ignored, or may have navigation functions associated with
       
    63 them (see <xref href="GUID-EEF2F892-8900-475F-926B-A49D0D98C1C6.dita">Navigation</xref>).</p></entry>
       
    64 </row>
       
    65 <row>
       
    66 <entry><p>Selection key</p></entry>
       
    67 <entry><p>Selects the item; see the discussion above.</p></entry>
       
    68 </row>
       
    69 <row>
       
    70 <entry><p>Left softkey (Options)</p></entry>
       
    71 <entry><p>Opens the Options menu (see <xref href="GUID-BFEEECCA-190B-4DDE-8A04-4FE918BE8690.dita">Options
       
    72 menu</xref>).</p></entry>
       
    73 </row>
       
    74 <row>
       
    75 <entry><p>Right softkey (Back; Exit)</p></entry>
       
    76 <entry><p>Back stepping (see<xref href="GUID-EEF2F892-8900-475F-926B-A49D0D98C1C6.dita">Navigation</xref>).</p></entry>
       
    77 </row>
       
    78 <row>
       
    79 <entry><p>Clear</p></entry>
       
    80 <entry><p>Deletes the item if it can be deleted (confirmation from the user
       
    81 is required); otherwise ignored.</p></entry>
       
    82 </row>
       
    83 <row>
       
    84 <entry><p>Edit</p></entry>
       
    85 <entry><p>Ignored, or a marking function if the list is markable (see <xref href="GUID-ED784025-4E65-4BE9-ADA8-A13427B6EA30.dita">Markable list</xref>).</p></entry>
       
    86 </row>
       
    87 <row>
       
    88 <entry><p>Numeric keypad</p></entry>
       
    89 <entry><p>May be ignored, or may have specific functions within the state.</p></entry>
       
    90 </row>
       
    91 <row>
       
    92 <entry><p>Other keys</p></entry>
       
    93 <entry><p>Do the default action of the key.</p></entry>
       
    94 </row>
       
    95 </tbody>
       
    96 </tgroup>
       
    97 </table>
       
    98 <p/>
       
    99 <p>The following table lists the default touch events for selection list:</p>
       
   100 <table id="GUID-5B8DA500-4092-4E1A-A035-308C4D352138-GENID-1-8-1-6-1-1-5-1-11-1-1-4-1-2-13"><title>Default touch
       
   101 events for Selection list.</title>
       
   102 <tgroup cols="3">
       
   103 
       
   104 <colspec colname="col1" colwidth="0.80*"/><colspec colname="col2" colwidth="1.01*"/>
       
   105 <colspec colname="col3" colwidth="1.19*"/>
       
   106 <thead>
       
   107 <row>
       
   108 <entry valign="top"><p>User action</p></entry>
       
   109 <entry valign="top"><p>State change</p></entry>
       
   110 <entry valign="top"><p>Feedback</p></entry>
       
   111 </row>
       
   112 </thead>
       
   113 <tbody>
       
   114 <row>
       
   115 <entry><p>Touch down</p></entry>
       
   116 <entry><p>No effect</p></entry>
       
   117 <entry><p>Highlight is shown. </p><p>Tactile: Basic list effect and audio
       
   118 feedback is provided with touch down event.</p></entry>
       
   119 </row>
       
   120 <row>
       
   121 <entry><p>Touch release</p></entry>
       
   122 <entry><p>Item is activated.</p></entry>
       
   123 <entry><p>Highlight disappears. </p><p>Tactile: Basic list effect is provided
       
   124 with touch release event.</p></entry>
       
   125 </row>
       
   126 <row>
       
   127 <entry><p>Touch down and hold</p></entry>
       
   128 <entry><p>Stylus pop-up menu is opened.</p></entry>
       
   129 <entry><p>Highlight is shown. Animation is shown to indicate the opening pop-up. </p><p>Tactile:
       
   130 If activates a long touch, then increasing long touch effect is provided with
       
   131 hold event. Pop-up effect is provided when the pop-up is opened.</p></entry>
       
   132 </row>
       
   133 <row>
       
   134 <entry><p>Touch event combinations, refer to <xref href="GUID-7C61D3D7-8FCB-46AB-B2E9-CE1AC68F86DE.dita">Dragging
       
   135 and flicking</xref> events.</p></entry>
       
   136 <entry><p>Refer to <xref href="GUID-7C61D3D7-8FCB-46AB-B2E9-CE1AC68F86DE.dita">Dragging
       
   137 and flicking</xref> events.</p></entry>
       
   138 <entry><p>Tactile: Refer to <xref href="GUID-7C61D3D7-8FCB-46AB-B2E9-CE1AC68F86DE.dita">Dragging
       
   139 and flicking</xref> events.</p></entry>
       
   140 </row>
       
   141 </tbody>
       
   142 </tgroup>
       
   143 </table>
       
   144 <fig id="GUID-4149CCA2-D8FE-4393-8D82-A736EF5337C5">
       
   145 <title>Selection lists </title>
       
   146 <image href="GUID-829C15B1-0769-4E90-935D-4DCA58895E81_d0e61742_href.png" placement="inline"/>
       
   147 </fig>
       
   148 <section id="GUID-FA4ACC82-0080-429B-A155-433F175138A6"><title>Using
       
   149 selection lists in C++ applications</title><p>The API to use for selection
       
   150 lists is the <xref format="html" href="specs/guides/Lists_API_Specification/Lists_API_Specification.html" scope="peer">Lists API</xref>. For implementation information,
       
   151 see <xref format="htrml" href="specs/guides/Lists_API_Specification/Lists_API_Specification.html#Lists_API_Specification.topic3" scope="peer">Using the Lists API</xref>.</p></section>
       
   152 </conbody></concept>