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_d0e67259_href.png" placement="inline"/> |
17 <image href="GUID-876EE000-01B7-4457-AE9C-CE56E48CFF11_d0e67402_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> |
45 is recommended), and the number should not be dynamic. See <xref href="GUID-72DE3EB1-1AF5-4157-8B99-A1C7143DAD2C.dita"/> for |
45 is recommended), and the number should not be dynamic. See <xref href="GUID-72DE3EB1-1AF5-4157-8B99-A1C7143DAD2C.dita"/> for |
46 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> |
47 </row> |
47 </row> |
48 <row> |
48 <row> |
49 <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"> |
50 <image href="GUID-6FE79448-5052-46F9-A74E-A128CB367697_d0e67337_href.png" scale="30" placement="inline"/> |
50 <image href="GUID-6FE79448-5052-46F9-A74E-A128CB367697_d0e67478_href.png" scale="30" placement="inline"/> |
51 </fig></entry> |
51 </fig></entry> |
52 <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 |
53 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. |
54 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> |
55 </row> |
55 </row> |
56 <row> |
56 <row> |
57 <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"> |
58 <image href="GUID-03A3E872-8183-4F56-976E-A6AF435742C6_d0e67355_href.png" scale="30" placement="inline"/> |
58 <image href="GUID-03A3E872-8183-4F56-976E-A6AF435742C6_d0e67496_href.png" scale="30" placement="inline"/> |
59 </fig></entry> |
59 </fig></entry> |
60 <entry><p>In editors, the <uicontrol>Navi pane</uicontrol> contains editing |
60 <entry><p>In editors, the <uicontrol>Navi pane</uicontrol> contains editing |
61 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 |
62 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> |
63 </row> |
63 </row> |
64 <row> |
64 <row> |
65 <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"> |
66 <image href="GUID-257212F5-A414-4F17-A786-DB3168218139_d0e67378_href.png" scale="30" placement="inline"/> |
66 <image href="GUID-257212F5-A414-4F17-A786-DB3168218139_d0e67519_href.png" scale="30" placement="inline"/> |
67 </fig></entry> |
67 </fig></entry> |
68 <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> |
69 </row> |
69 </row> |
70 <row> |
70 <row> |
71 <entry><p>Application-specific content</p></entry> |
71 <entry><p>Application-specific content</p></entry> |
72 <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 |
73 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> |
74 </row> |
74 </row> |
75 <row> |
75 <row> |
76 <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"> |
77 <image href="GUID-E64A8D76-28AD-4F75-9E92-3290488F85D9_d0e67410_href.png" scale="30" placement="inline"/> |
77 <image href="GUID-E64A8D76-28AD-4F75-9E92-3290488F85D9_d0e67551_href.png" scale="30" placement="inline"/> |
78 </fig></entry> |
78 </fig></entry> |
79 <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> |
80 </row> |
80 </row> |
81 </tbody> |
81 </tbody> |
82 </tgroup> |
82 </tgroup> |
83 </table> |
83 </table> |
84 <p/> |
84 <section><title>Using the navi pane in |
85 <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 |
86 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 |
87 <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, |
88 <thead> |
88 see <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/Navigation_Pane_API4.html" format="application/java-archive">Using |
89 <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 |
90 <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 |
91 <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 |
92 <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 |
93 </row> |
93 method for a pre-implemented navigation pane tab group control.</p></section> |
94 </thead> |
|
95 <tbody> |
|
96 <row> |
|
97 <entry><p>Touch down on navigation text or navigation arrow</p></entry> |
|
98 <entry><p>Application specific</p></entry> |
|
99 <entry><p>Tactile: In case of activity, basic button effect and audio feedback |
|
100 is provided.</p></entry> |
|
101 </row> |
|
102 <row> |
|
103 <entry><p>Touch down and hold on navigation text</p></entry> |
|
104 <entry><p>Inactive</p></entry> |
|
105 <entry><p>Tactile: No effect</p></entry> |
|
106 </row> |
|
107 <row> |
|
108 <entry><p>Touch down and hold on arrows</p></entry> |
|
109 <entry><p>This action performs a “key repeat”, similar to many touch downs |
|
110 and releases on arrow</p></entry> |
|
111 <entry><p>Tactile: Sensitive button effect and audio feedback is provided |
|
112 with key repeat action.</p></entry> |
|
113 </row> |
|
114 <row> |
|
115 <entry><p>Touch release</p></entry> |
|
116 <entry><p>No effect</p></entry> |
|
117 <entry><p>Tactile: No effect</p></entry> |
|
118 </row> |
|
119 </tbody> |
|
120 </tgroup> |
|
121 </table> |
|
122 <section id="GUID-3E478FC5-080A-4EAF-98F4-B0C0F1C8E19D"><title>Using |
|
123 the navi pane in applications</title><p>The API to use for the Navi pane is |
|
124 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, |
|
125 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 |
|
126 the touch events in the Navi pane area.</p><p>For the indicators |
|
127 in the Navi pane, use the Indicators API.</p><p>For implementation information |
|
128 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 |
|
129 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 |
|
130 provides touch support for the tab arrows in the Navi pane. To set the observer, |
|
131 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 |
|
132 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>. |
|
133 This is a factory method for a pre-implemented navigation pane tab group control.</p></section> |
|
134 </conbody></concept> |
94 </conbody></concept> |