Symbian3/SDK/Source/GUID-16950F22-F5DE-4D52-8414-544105BA3200.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-16950F22-F5DE-4D52-8414-544105BA3200" xml:lang="en"><title>Hierarchical
       
    13 list</title><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    14 <p>The hierarchical list component (a "tree list") is available for use in
       
    15 dialogs that deal with moving items to and from (or copying them) from one
       
    16 folder to another. The main use situation for the component is the File Manager
       
    17 folder and file browsing, when the actual data is being showed in the same
       
    18 view. The hierarchical list component allows users to browse through their
       
    19 folder content by having a list and its content available simultaneously:
       
    20 the user can simply expand a listed item (folder) to show its content.</p>
       
    21 <p>Unlike the other Symbian list types, the hierarchical list component is
       
    22 not structured on the A   D column structure. Visually, the hierarchical levels
       
    23 are connected with vertical lines (see the figure below), and the folders
       
    24 in each hierarchy level are shown before files on that same level. Scroll
       
    25 bars function as usual (vertical bar is always present, horizontal bar is
       
    26 available when necessary), and the list does not loop by default, although
       
    27 it is possible to enable looping. Marquee scrolling is supported, but if not
       
    28 used, the names of folders and files are truncated where necessary. The height
       
    29 and the vertical distribution of the folder/file texts on the list is the
       
    30 same as in normal lists. Hierarchical lists can be used both in the main pane
       
    31 and as pop-ups.</p>
       
    32 <fig id="GUID-5CC170B7-72AA-422E-8C44-AFB135C596D6">
       
    33 <title>Hierarchical list component</title>
       
    34 <image href="GUID-341CE215-056C-45B6-ABE2-C75442605147_d0e62833_href.png" scale="40" placement="inline"/>
       
    35 </fig>
       
    36 <p>Owing to the need for horizontal scrolling, it is not possible to use tabs
       
    37 in the Navi pane. Typically the hierarchical list component is capable of
       
    38 showing three hierarchy levels in portrait orientation, but this may vary
       
    39 according to the display sizes and resolutions as well as the display orientation.
       
    40 The order of folders (sorting order) on each level is defined by the application.</p>
       
    41 <p><b>General navigation:</b></p>
       
    42 <ul>
       
    43 <li><p>Arrow keys either expand collapsed folders (Arrow right, the focus
       
    44 does not move yet), collapse expanded folders (Arrow left: one press to move
       
    45 the focus onto the parent folder when there is one, second press to collapse
       
    46 the contents), or move the focus into the direction of scrolling. </p></li>
       
    47 <li><p>The Selection key expands collapsed (or vice versa) folders or opens
       
    48 files under focus. </p></li>
       
    49 <li><p>Commands for expanding, collapsing and opening folders or files are
       
    50 also available in the <b>Options</b> menu.</p></li>
       
    51 </ul>
       
    52 <table id="GUID-7E9F23CF-F8F3-4E51-98DF-5789C447F08F"><title>Default touch
       
    53 events for hierarchical list items</title>
       
    54 <tgroup cols="3">
       
    55 
       
    56 <colspec colname="col1" colwidth="0.80*"/><colspec colname="col2" colwidth="1.01*"/>
       
    57 <colspec colname="col3" colwidth="1.19*"/>
       
    58 <thead>
       
    59 <row>
       
    60 <entry valign="top"><p>User action</p></entry>
       
    61 <entry valign="top"><p>State change</p></entry>
       
    62 <entry valign="top"><p>Feedback</p></entry>
       
    63 </row>
       
    64 </thead>
       
    65 <tbody>
       
    66 <row>
       
    67 <entry><p>Touch down on collapsed folder</p></entry>
       
    68 <entry><p>No change</p></entry>
       
    69 <entry><p>Highlight is shown.</p><p>Tactile: Basic list effect and audio feedback
       
    70 is provided with touch down event.</p></entry>
       
    71 </row>
       
    72 <row>
       
    73 <entry><p>Touch release on collapsed folder</p></entry>
       
    74 <entry><p>Item is expanded. If the folder is empty, the only action performed
       
    75 is that the icon is changed to expanded folder indication.</p></entry>
       
    76 <entry><p>Highlight disappears. </p><p>Tactile: Basic list effect is provided
       
    77 with touch release event.</p></entry>
       
    78 </row>
       
    79 <row>
       
    80 <entry><p>Touch down on expanded folder</p></entry>
       
    81 <entry><p>No change</p></entry>
       
    82 <entry><p>Highlight is shown. </p><p>Tactile: Basic list effect and audio
       
    83 feedback is provided with touch release event.</p></entry>
       
    84 </row>
       
    85 <row>
       
    86 <entry><p>Touch release on expanded folder</p></entry>
       
    87 <entry><p>Item is collapsed. </p><p>If the folder is empty, only action is
       
    88 that the icon is changed to collapsed folder indication.</p></entry>
       
    89 <entry><p>Highlight disappears. </p><p>Tactile: Basic list effect is provided
       
    90 with touch release event.</p></entry>
       
    91 </row>
       
    92 <row>
       
    93 <entry><p>Touch down and hold on folder</p></entry>
       
    94 <entry><p>Stylus pop-up menu opens.</p></entry>
       
    95 <entry><p>Highlight is shown. Animation is shown to indicate the opening pop-up. </p><p>Tactile:
       
    96 If activates a long touch, then increasing long touch effect given with hold
       
    97 event and pop-up effect is provided when the pop-up is opened.</p></entry>
       
    98 </row>
       
    99 <row>
       
   100 <entry><p>Touch down on file</p></entry>
       
   101 <entry><p>No change</p></entry>
       
   102 <entry><p>Highlight is shown. </p><p>Tactile: Sensitive list effect and audio
       
   103 feedback is provided with touch down event.</p></entry>
       
   104 </row>
       
   105 <row>
       
   106 <entry><p>Touch release on file</p></entry>
       
   107 <entry><p>Item is activated.</p></entry>
       
   108 <entry><p>Highlight disappears. </p><p>Tactile: Sensitive list effect is provided
       
   109 with touch down and release event.</p></entry>
       
   110 </row>
       
   111 <row>
       
   112 <entry><p>Touch down and hold on file</p></entry>
       
   113 <entry><p>Stylus pop-up menu is opened.</p></entry>
       
   114 <entry><p>Highlight is shown. Animation is shown to indicate the opening pop-up. </p><p>Tactile:
       
   115 If activates a long touch, then increasing long touch effect given with hold
       
   116 event and pop-up effect given when the pop-up is opened.</p></entry>
       
   117 </row>
       
   118 <row>
       
   119 <entry><p>Touch down on item and move</p></entry>
       
   120 <entry><p>Refer to <xref href="GUID-7C61D3D7-8FCB-46AB-B2E9-CE1AC68F86DE.dita">Dragging
       
   121 and flicking</xref> events</p><p>Expand and collapse functions are not done
       
   122 while dragging.</p></entry>
       
   123 <entry><p>Tactile: Refer to <xref href="GUID-7C61D3D7-8FCB-46AB-B2E9-CE1AC68F86DE.dita">Dragging
       
   124 and flicking</xref> events.</p></entry>
       
   125 </row>
       
   126 <row>
       
   127 <entry><p>Touch down on item and move horizontally</p></entry>
       
   128 <entry><p>Inactive</p></entry>
       
   129 <entry><p>Tactile: No effect</p></entry>
       
   130 </row>
       
   131 </tbody>
       
   132 </tgroup>
       
   133 </table>
       
   134 <section id="GUID-E507585F-2B77-49BC-B982-76E143E7BF2A"><title>Using
       
   135 hierarchical lists in C++ applications</title><p>The API to use for hierarchical
       
   136 lists is the <xref format="html" href="specs/guides/Hierarchical_Lists_API_Specification/Hierarchical_Lists_API_Specification.html" scope="peer">Hierarchical lists API</xref>. For implementation information,
       
   137 see <xref format="html" href="specs/guides/Hierarchical_Lists_API_Specification/Hierarchical_Lists_API_Specification.html#Hierarchical_Lists_API_Specification.topic3" scope="peer">Using the Hierarchical lists API</xref>.</p></section>
       
   138 </conbody></concept>