Mercurial Mercurial > oss > FCL > sftools > depl > docscontent / comparison
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Symbian3/PDK/Source/GUID-76FD2A71-E8A3-4C82-9704-3F7F6AD4DFD8.dita
changeset 12 80ef3a206772
parent 9 59758314f811
child 14 578be2adaf3e
equal deleted inserted replaced
11:5072524fcc79 12:80ef3a206772 
     7     Nokia Corporation - initial contribution.
 
     7     Nokia Corporation - initial contribution.
 
     8 Contributors: 
     8 Contributors: 
     9 -->
 
     9 -->
 
    10 <!DOCTYPE concept
 
    10 <!DOCTYPE concept
 
    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
 
    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
 
    12 <concept id="GUID-76FD2A71-E8A3-4C82-9704-3F7F6AD4DFD8" xml:lang="en"><title>Navi
 
    12 <concept id="GUID-76FD2A71-E8A3-4C82-9704-3F7F6AD4DFD8" xml:lang="en"><title>Navi pane</title><prolog><metadata><keywords/></metadata></prolog><conbody>
 
    13 pane</title><prolog><metadata><keywords/></metadata></prolog><conbody>
 
       
    14 <p>The principal uses of the Navi pane are to display information about the
 
    13 <p>The principal uses of the Navi pane are to display information about the
 
    15 current state and view, and to help the user to navigate in the application.</p>
 
    14 current state and view, and to help the user to navigate in the application.</p>
 
    16 <fig id="GUID-3E3F8A70-C0EB-4B17-AB6D-7374FBF8B453">
 
    15 <fig id="GUID-1F8587D9-3439-4AD6-8687-3B4D9ADF27AB">
 
    17 <title>Navi pane</title>
 
    16 <title>Navi pane</title>
 
    18 <image href="GUID-EDBCCC26-BA4D-4318-9F0D-62272FA97BBF_d0e95358_href.png" placement="inline"/>
 
    17 <image href="GUID-876EE000-01B7-4457-AE9C-CE56E48CFF11_d0e99556_href.png" scale="40" placement="inline"/>
 
    19 </fig>
 
    18 </fig>
 
    20 <p>Depending on the context, the Navi pane contains elements presented in
 
    19 <p>Depending on the context, the Navi pane contains elements presented in
 
    21 the following table.</p>
 
    20 the following table.</p>
 
    22 <table id="GUID-8F674003-C512-4E42-BB7E-85A55F93E3BB"><title>Possible Navi
 
    21 <table id="GUID-8F674003-C512-4E42-BB7E-85A55F93E3BB"><title>Possible Navi
 
    23 pane content</title>
 
    22 pane content</title>
 
    30 </thead>
 
    29 </thead>
 
    31 <tbody>
 
    30 <tbody>
 
    32 <row>
 
    31 <row>
 
    33 <entry><p>Tabs</p><fig id="GUID-2CBA76C9-3918-40C7-889B-BC5181B34955"/></entry>
 
    32 <entry><p>Tabs</p><fig id="GUID-2CBA76C9-3918-40C7-889B-BC5181B34955"/></entry>
 
    34 <entry><p>Tabs are used to view parallel data views alternatively. Arrow indicators
 
    33 <entry><p>Tabs are used to view parallel data views alternatively. Arrow indicators
 
    35 are used only for navigation texts. </p><p>Each tab has either a graphic or
 
    34 are shown at both ends of the pane when there are further tabs to scroll in
 
    36 a text (or both) as a label. The following tab layouts can be used: <ul>
 
    35 the corresponding direction. Each tab has either a graphic or a text (or both)
 
       
    36 as a label. The following tab layouts can be used: <ul>
 
    37 <li><p>Two tabs</p></li>
 
    37 <li><p>Two tabs</p></li>
 
    38 <li> <p>Three tabs</p></li>
 
    38 <li> <p>Three tabs</p></li>
 
    39 <li><p>Four tabs</p></li>
 
    39 <li><p>Four tabs</p></li>
 
    40 <li><p>Two long tabs</p></li>
 
    40 <li><p>Two long tabs</p></li>
 
    41 <li> <p>Three long tabs (stacked so that only one is fully visible at a time)</p></li>
 
    41 <li> <p>Three long tabs (stacked so that only one is fully visible at a time)</p></li>
 
    42 </ul>The currently active tab is highlighted.</p><p>More than four tabs can
 
    42 </ul>The currently active tab is highlighted.</p><p>More than four tabs can
 
    43 exist simultaneously. They can be scrolled horizontally. However, as a design
 
    43 exist simultaneously. They can be scrolled horizontally. However, as a design
 
    44 guideline, the number of tabs should be kept small (the maximum of six tabs
 
    44 guideline, the number of tabs should be kept small (the maximum of six tabs
 
    45 is recommended), and the number should not be dynamic. See <xref href="GUID-72DE3EB1-1AF5-4157-8B99-A1C7143DAD2C.dita">Navigation
 
    45 is recommended), and the number should not be dynamic. See <xref href="GUID-72DE3EB1-1AF5-4157-8B99-A1C7143DAD2C.dita"/> for
 
    46 using tabs</xref> for
 
       
    47 a description of the effect of tabs on the navigation within an application.</p></entry>
 
    46 a description of the effect of tabs on the navigation within an application.</p></entry>
 
    48 </row>
 
    47 </row>
 
    49 <row>
 
    48 <row>
 
    50 <entry><p>Navigation text (icon+text)</p><fig id="GUID-B2C30B15-0343-4430-8535-05C8BAAB1B7B">
 
    49 <entry><p>Navigation text (icon+text)</p><fig id="GUID-B2C30B15-0343-4430-8535-05C8BAAB1B7B">
 
    51 <image href="GUID-6FE79448-5052-46F9-A74E-A128CB367697_d0e95436_href.png" scale="30" placement="inline"/>
 
    50 <image href="GUID-6FE79448-5052-46F9-A74E-A128CB367697_d0e99632_href.png" scale="30" placement="inline"/>
 
    52 </fig></entry>
 
    51 </fig></entry>
 
    53 <entry><p>Navigation text is displayed in the <uicontrol>Navi pane</uicontrol> when
 
    52 <entry><p>Navigation text is displayed in the <uicontrol>Navi pane</uicontrol> when
 
    54 similar items can be browsed by scrolling horizontally, such as dates in Calendar.
 
    53 similar items can be browsed by scrolling horizontally, such as dates in Calendar.
 
    55 Arrow indicators at both ends of the pane indicate the possibility to scroll.</p></entry>
 
    54 Arrow indicators at both ends of the pane indicate the possibility to scroll.</p></entry>
 
    56 </row>
 
    55 </row>
 
    57 <row>
 
    56 <row>
 
    58 <entry><p>Indicators</p><fig id="GUID-89499CD6-C3C5-4BD5-964A-02ADD8A30116">
 
    57 <entry><p>Indicators</p><fig id="GUID-89499CD6-C3C5-4BD5-964A-02ADD8A30116">
 
    59 <image href="GUID-03A3E872-8183-4F56-976E-A6AF435742C6_d0e95454_href.png" scale="30" placement="inline"/>
 
    58 <image href="GUID-03A3E872-8183-4F56-976E-A6AF435742C6_d0e99650_href.png" scale="30" placement="inline"/>
 
    60 </fig></entry>
 
    59 </fig></entry>
 
    61 <entry><p>In editors, the <uicontrol>Navi pane</uicontrol> contains editing
 
    60 <entry><p>In editors, the <uicontrol>Navi pane</uicontrol> contains editing
 
    62 indicators. See <xref href="GUID-BA8806CC-BE7C-4927-ACF6-DA0CB6E96AAA.dita">Indicators</xref> for
 
    61 indicators. See <xref href="GUID-BA8806CC-BE7C-4927-ACF6-DA0CB6E96AAA.dita">Indicators</xref> for
 
    63 a more detailed description of the <uicontrol>Navi pane</uicontrol> indicators.</p></entry>
 
    62 a more detailed description of the <uicontrol>Navi pane</uicontrol> indicators.</p></entry>
 
    64 </row>
 
    63 </row>
 
    65 <row>
 
    64 <row>
 
    66 <entry><p>Folder structure indication</p><fig id="GUID-274C1478-A141-4705-A6BF-E99703FE714D">
 
    65 <entry><p>Folder structure indication</p><fig id="GUID-274C1478-A141-4705-A6BF-E99703FE714D">
 
    67 <image href="GUID-257212F5-A414-4F17-A786-DB3168218139_d0e95477_href.png" scale="30" placement="inline"/>
 
    66 <image href="GUID-257212F5-A414-4F17-A786-DB3168218139_d0e99673_href.png" scale="30" placement="inline"/>
 
    68 </fig></entry>
 
    67 </fig></entry>
 
    69 <entry><p>Opened sub-folders are indicated in the <uicontrol>Navi pane</uicontrol>.</p></entry>
 
    68 <entry><p>Opened subfolders are indicated in the <uicontrol>Navi pane</uicontrol>.</p></entry>
 
    70 </row>
 
    69 </row>
 
    71 <row>
 
    70 <row>
 
    72 <entry><p>Application-specific content</p></entry>
 
    71 <entry><p>Application-specific content</p></entry>
 
    73 <entry><p>When none of the above content types is suitable, the <uicontrol>Navi
 
    72 <entry><p>When none of the above content types is suitable, the <uicontrol>Navi
 
    74 pane</uicontrol> content can be designed specifically for an application.</p></entry>
 
    73 pane</uicontrol> content can be designed specifically for an application.</p></entry>
 
    75 </row>
 
    74 </row>
 
    76 <row>
 
    75 <row>
 
    77 <entry><p>Empty pane</p><fig id="GUID-85A80F31-F9ED-4ECE-BAF0-5A2083CE578A">
 
    76 <entry><p>Empty pane</p><fig id="GUID-85A80F31-F9ED-4ECE-BAF0-5A2083CE578A">
 
    78 <image href="GUID-E64A8D76-28AD-4F75-9E92-3290488F85D9_d0e95509_href.png" scale="30" placement="inline"/>
 
    77 <image href="GUID-E64A8D76-28AD-4F75-9E92-3290488F85D9_d0e99705_href.png" scale="30" placement="inline"/>
 
    79 </fig></entry>
 
    78 </fig></entry>
 
    80 <entry><p>The <uicontrol>Navi pane</uicontrol> can be empty.</p></entry>
 
    79 <entry><p>The <uicontrol>Navi pane</uicontrol> can be empty.</p></entry>
 
    81 </row>
 
    80 </row>
 
    82 </tbody>
 
    81 </tbody>
 
    83 </tgroup>
 
    82 </tgroup>
 
    84 </table>
 
    83 </table>
 
    85 <p/>
 
    84 <section><title>Using the navi pane in
 
    86 <table id="GUID-D5CFA14A-79F4-4E9C-A051-6588C7DDAC59"><title>Default touch
 
    85 C++ applications</title><p>The API to use for the Navi pane is the <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/Navigation_Pane_APIIndexPage.html" format="application/java-archive">Navigation pane API</xref>. If you use tabs in the Navi pane, the API for
 
    87 events for ungrouped soft notification</title>
 
    86 controlling the tabs is the <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/Tabs_APIIndexPage.html" format="application/java-archive">Tabs
 
    88 <tgroup cols="3"><colspec colname="col1" colwidth="0.80*"/><colspec colname="col2" colwidth="1.01*"/><colspec colname="col3" colwidth="1.19*"/>
 
    87 API</xref>.</p><p>For the indicators in the Navi pane, use the <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/Indicators_APIIndexPage.html" format="application/java-archive">Indicators API</xref>.</p><p>For implementation information on the Navi pane,
 
    89 <thead>
 
    88 see <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/Navigation_Pane_API4.html" format="application/java-archive">Using
 
    90 <row>
 
    89 the Navigation pane API</xref>. For implementation information on tabs, see <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/Tabs_API4.html" format="application/java-archive">Using
 
    91 <entry valign="top"><p>User action</p></entry>
 
    90 the Tabs API</xref>.</p><p>The class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classMAknNaviDecoratorObserver.html" format="application/java-archive"><codeph>MAknNaviDecoratorObserver</codeph></xref> provides touch support for the tab arrows in the Navi pane. To set
 
    92 <entry valign="top"><p>State change</p></entry>
 
    91 the observer, use the method <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNavigationDecorator.html#660e9ba08945b213aba477b7863873cc" format="application/java-archive"><codeph>CAknNavigationDecorator::SetNaviDecoratorObserver()</codeph></xref>.</p><p>To
 
    93 <entry valign="top"><p>Feedback</p></entry>
 
    92 create a tab group in the Navi pane, use the method <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNavigationControlContainer.html#93d16329080f21bcd8428db61f177abc" format="application/java-archive"><codeph>CreateTabGroupL()</codeph></xref> in the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNavigationControlContainer.html" format="application/java-archive"><codeph>CAknNavigationControlContainer</codeph></xref>. This is a factory
 
    94 </row>
 
    93 method for a pre-implemented navigation pane tab group control.</p></section>
 
    95 </thead>
 
       
    96 <tbody>
 
       
    97 <row>
 
       
    98 <entry><p>Touch down on navigation text or navigation arrow</p></entry>
 
       
    99 <entry><p>Application specific</p></entry>
 
       
   100 <entry><p>Tactile: In case of activity, basic button effect and audio feedback
 
       
   101 is provided.</p></entry>
 
       
   102 </row>
 
       
   103 <row>
 
       
   104 <entry><p>Touch down and hold on navigation text</p></entry>
 
       
   105 <entry><p>Inactive</p></entry>
 
       
   106 <entry><p>Tactile: No effect</p></entry>
 
       
   107 </row>
 
       
   108 <row>
 
       
   109 <entry><p>Touch down and hold on arrows</p></entry>
 
       
   110 <entry><p>This action performs a “key repeat”, similar to many touch downs
 
       
   111 and releases on arrow</p></entry>
 
       
   112 <entry><p>Tactile: Sensitive button effect and audio feedback is provided
 
       
   113 with key repeat action.</p></entry>
 
       
   114 </row>
 
       
   115 <row>
 
       
   116 <entry><p>Touch release</p></entry>
 
       
   117 <entry><p>No effect</p></entry>
 
       
   118 <entry><p>Tactile: No effect</p></entry>
 
       
   119 </row>
 
       
   120 </tbody>
 
       
   121 </tgroup>
 
       
   122 </table>
 
       
   123 <section id="GUID-3E478FC5-080A-4EAF-98F4-B0C0F1C8E19D"><title>Using
 
       
   124 the navi pane in applications</title><p>The API to use for the Navi pane is
 
       
   125 the <xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html" scope="peer">Navigation pane API</xref>. If you use tabs in the Navi pane,
 
       
   126 the API for controlling the tabs is the <xref format="html" href="specs/guides/Tabs_API_Specification/Tabs_API_Specification.html" scope="peer">Tabs API</xref>. Applications can implement an observer to handle
 
       
   127 the touch events in the Navi pane area.</p><p>For the indicators
 
       
   128 in the Navi pane, use the Indicators API.</p><p>For implementation information
 
       
   129 on the Navi pane, see <xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html#Navigation_Pane_API_Specification.topic3" scope="peer">Using the Navigation pane API</xref>. For implementation information
 
       
   130 on tabs, see <xref format="html" href="specs/guides/Tabs_API_Specification/Tabs_API_Specification.html#Tabs_API_Specification.topic3" scope="peer">Using the Tabs API</xref>.</p><p>The <xref href="GUID-1239E9D4-0184-350E-A344-144499E0563E.dita"><apiname>MAknNaviDecoratorObserver</apiname></xref> class
 
       
   131 provides touch support for the tab arrows in the Navi pane. To set the observer,
 
       
   132 use the <xref href="GUID-7E710ED4-F210-3BD0-AC0A-DC506E327B32.dita#GUID-7E710ED4-F210-3BD0-AC0A-DC506E327B32/GUID-3EE352C1-5B27-30DB-9D72-21A84A89E7AB"><apiname>CAknNavigationDecorator::SetNaviDecoratorObserver()</apiname></xref> method.</p><p>To
 
       
   133 create a tab group in the Navi pane, use the <xref href="GUID-985BFC71-A477-39EF-9134-6495131BA449.dita#GUID-985BFC71-A477-39EF-9134-6495131BA449/GUID-1DA90B0F-D97F-3556-8180-7F99081E9373"><apiname>CAknNavigationControlContainer::CreateTabGroupL()</apiname></xref>.
 
       
   134 This is a factory method for a pre-implemented navigation pane tab group control.</p></section>
 
       
   135 </conbody></concept>
 
    94 </conbody></concept>
FCL/sftools/depl/docscontent