Symbian3/SDK/Source/GUID-BFEEECCA-190B-4DDE-8A04-4FE918BE8690.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-BFEEECCA-190B-4DDE-8A04-4FE918BE8690" xml:lang="en"><title>Options
       
    13 menu</title><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    14 <p>The <uicontrol>Options</uicontrol> menu is a tool that offers the user
       
    15 a set of possible functions in the current context. Pressing the left softkey
       
    16 labeled <uicontrol>Options</uicontrol> opens the <uicontrol>Options</uicontrol> menu.</p>
       
    17 <fig id="GUID-DE323941-E70E-4169-9F67-6E7A11047481">
       
    18 <title>Options menu</title>
       
    19 <image href="GUID-8BA0D643-5ED1-4DC4-82EC-C8AA392DCBC4_d0e65577_href.png" placement="inline"/>
       
    20 </fig>
       
    21 <p>The <uicontrol>Options</uicontrol> menu is a menu list displayed in a pop-up
       
    22 window. An item is selected by pressing either the left softkey (<uicontrol>Select</uicontrol>)
       
    23 or the Selection key. The user must either select an item from the list or
       
    24 cancel the menu; it cannot be left pending during another action (see <xref href="GUID-0BAE2D0E-604B-4A62-B5EB-AC68EAF7F589.dita">Navigating in applications</xref>).</p>
       
    25 <p>The pop-up window is located above the <xref href="GUID-8B137691-7C9E-4085-BFFE-4CFE4A64A091.dita">Control
       
    26 pane</xref>, and its height is dynamic; the maximum size is approximately
       
    27 the size of the standard main pane. The content on the screen outside the
       
    28 menu pop-up is dimmed, except the Control pane.</p>
       
    29 <p>Options menu items that are item-specific and require an item on the screen
       
    30 to be focused, are not displayed in the <b>Options</b> menu unless user has
       
    31 opened the Options menu while navigating the UI with hardware keys. The item
       
    32 specific commands are hidden in the <b>Options</b> menu while moving with
       
    33 touch, and are made visible when activating the hardware interaction. The
       
    34 item specific commands are not updated or removed, while the <b>Options</b> menu
       
    35 is open.</p>
       
    36 <p>Items in the <uicontrol>Options</uicontrol> menu use the single item layout;
       
    37 that is, they are text-only. The number of items in the menu is not limited,
       
    38 because the list scrolls as necessary. The <uicontrol>Options</uicontrol> always
       
    39 loops, which allows users to easily reach the end of the list.</p>
       
    40 <table id="GUID-F71BE5D4-D757-476F-811A-E3364937E3DB"><title>Default touch
       
    41 events for Options menu</title>
       
    42 <tgroup cols="3"><colspec colname="col1" colwidth="0.80*"/><colspec colname="col2" colwidth="1.01*"/><colspec colname="col3" colwidth="1.19*"/>
       
    43 <thead>
       
    44 <row>
       
    45 <entry valign="top"><p>User action</p></entry>
       
    46 <entry valign="top"><p>State change</p></entry>
       
    47 <entry valign="top"><p>Feedback</p></entry>
       
    48 </row>
       
    49 </thead>
       
    50 <tbody>
       
    51 <row>
       
    52 <entry><p>Touch down (no sub-menu for the item)</p></entry>
       
    53 <entry><p>No effect <note> Submenu behaves similarly as the main menu.</note></p></entry>
       
    54 <entry><p>Highlight is shown. </p><p>Tactile: Basic list effect and audio
       
    55 feedback is provided with touch down event.</p></entry>
       
    56 </row>
       
    57 <row>
       
    58 <entry><p>Touch release (no sub-menu for the item)</p></entry>
       
    59 <entry><p>The focused item is activated and <b>Options</b> menu closed.</p></entry>
       
    60 <entry><p>Highlight disappears. </p><p>Tactile: Basic list effect is provided
       
    61 with touch release event.</p></entry>
       
    62 </row>
       
    63 <row>
       
    64 <entry><p>Touch down and release (when sub-menu available for the item)</p></entry>
       
    65 <entry><p>A submenu is opened. </p><p>The <b>Options</b> menu item for which
       
    66 the submenu was opened from (that is, parent item) must be visible.</p></entry>
       
    67 <entry><p>The parent item stays highlighted while the submenu is open to show
       
    68 the relation between the two. </p><p>The submenu does not have highlight unless
       
    69 it was opened with a hardware key. </p><p>Tactile: Basic list effect and audio
       
    70 feedback is provided with touch down and basic list effect with release event.
       
    71 For pop-up related tactile feedback, normal pop-up effect when opening and
       
    72 closing if the theme effects are OFF. If they are ON, then increasing long
       
    73 touch is used when opening and pop-up close effect when closing.</p></entry>
       
    74 </row>
       
    75 <row>
       
    76 <entry><p>Touch down on <b>Options</b> menu and move out of the <b>Options</b> menu</p></entry>
       
    77 <entry><p>Refer to <xref href="GUID-7C61D3D7-8FCB-46AB-B2E9-CE1AC68F86DE.dita">Dragging
       
    78 and flicking</xref> events</p></entry>
       
    79 <entry><p>Tactile: Refer to <xref href="GUID-7C61D3D7-8FCB-46AB-B2E9-CE1AC68F86DE.dita">Dragging
       
    80 and flicking</xref> events.</p></entry>
       
    81 </row>
       
    82 <row>
       
    83 <entry><p>Touch down and release outside the <b>Options</b> menu</p></entry>
       
    84 <entry><p>Inactive</p></entry>
       
    85 <entry><p>If there is hardware highlight, it disappears. </p><p>Tactile: No
       
    86 effect</p></entry>
       
    87 </row>
       
    88 <row>
       
    89 <entry><p>Touch down and release outside menu area when sub-menu is open</p></entry>
       
    90 <entry><p>Only the sub-menu is closed, main menu remains open.</p></entry>
       
    91 <entry><p>Highlight disappears from the parent menu item. </p><p>Tactile:
       
    92 Pop-up effect and sensitive audio feedback is provided with touch down event.
       
    93 If theme effects are ON, pop-up close effect is given with touch release.
       
    94 Else, no tactile feedback is provided with touch release.</p></entry>
       
    95 </row>
       
    96 </tbody>
       
    97 </tgroup>
       
    98 </table>
       
    99 <section id="GUID-FF69390C-BA3D-47D5-A0C9-031CBA2464FC"><title>Using
       
   100 the Options menu in C++ applications</title><p>The API to use for the <uicontrol>Options</uicontrol> menu
       
   101 is the <xref format="html" href="specs/guides/Options_Menu_API_Specification/Options_Menu_API_Specification.html" scope="peer">Options menu API</xref>. For implementation information, see <xref format="html" href="public_specs/GuidesA/Options_Menu_API_Specification/Options_Menu_API_Specification.html#Options_Menu_API_Specification%2etopic3" scope="peer">Using the Options menu API</xref>.</p></section>
       
   102 </conbody></concept>