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-771AF721-E2D7-41C8-BF97-5BD30D1A28AD" xml:lang="en"><title> Status |
12 <concept id="GUID-771AF721-E2D7-41C8-BF97-5BD30D1A28AD" xml:lang="en"><title> Status pane</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 pane</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <p>The Status pane displays status information of the current application |
13 <p>The Status pane displays status information of the current application |
15 and state, as well as general information about the device status, such as |
14 and state, as well as general information about the device status, |
16 signal strength and battery charge. The Status pane may also be totally left |
15 such as signal strength and battery charge. The Status pane may also |
17 out in certain applications or situations. </p> |
16 be totally left out in certain applications or situations. </p> |
18 <p>There are three different variations of the Status pane:<ul> |
17 <p>There are three different variations of the Status pane:<ul> |
19 <li><p>Normal status pane (includes both Title and Navi pane). </p></li> |
18 <li><p>Normal status pane (includes both Title and Navi pane). </p></li> |
20 <li><p>Flat status pane (includes only the Title pane).</p></li> |
19 <li><p>Flat status pane (includes only the Title pane).</p></li> |
21 <li><p>Thin status pane (special status pane used, for example, in the Browser |
20 <li><p>Thin status pane (special status pane used, for example, in |
22 application)</p></li> |
21 the Browser application)</p></li> |
23 </ul>Flat and thin Status panes can be used in cases where it is important |
22 </ul>Flat and thin Status panes can be used in cases where it is important |
24 to maximize Main pane area (for example, Browser). </p> |
23 to maximize Main pane area (for example, Browser). </p> |
25 <p>The Status pane contains the following sub-panes:</p> |
24 <p>The Status pane contains the following sub-panes:</p> |
26 <ul> |
25 <ul> |
27 <li><p>Title pane</p></li> |
26 <li><p>Battery pane</p></li> |
|
27 <li><p>Clock pane</p></li> |
28 <li><p>Navi pane</p></li> |
28 <li><p>Navi pane</p></li> |
29 <li><p>Signal pane</p></li> |
29 <li><p>Signal pane</p></li> |
30 <li><p>Battery pane</p></li> |
30 <li><p>Title pane</p></li> |
31 <li><p>Universal indicator pane</p></li> |
31 <li><p>Universal indicator pane</p></li> |
32 </ul> |
32 </ul> |
33 <fig id="GUID-770A54B6-9F18-4BC3-92A7-AFB4D9E40199"> |
33 <fig id="GUID-770A54B6-9F18-4BC3-92A7-AFB4D9E40199"> |
34 <title>Status pane areas</title> |
34 <title>Status pane areas</title> |
35 <image href="GUID-F2F19F40-E87B-4FF2-ABE8-4E14AE728364_d0e72186_href.png" placement="inline"/> |
35 <image href="GUID-F2F19F40-E87B-4FF2-ABE8-4E14AE728364_d0e66931_href.png" placement="inline"/> |
36 </fig> |
36 </fig> |
37 <section id="GUID-681C48E1-D94F-4960-8BC4-DEB5C8B677DF"><title>Using |
37 <p><b>Status pane items</b></p> |
38 the status pane in C++ applications</title><p>The API to use for the status |
38 <p>A single tap on: </p> |
39 pane is the <xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html" scope="peer">Status pane API</xref>. For implementation information, see <xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3" scope="peer">Using the status pane API</xref>.</p><p>Use the Status pane API |
39 <ul> |
40 for the following tasks:</p><ul> |
40 <li><p><xref href="GUID-76FD2A71-E8A3-4C82-9704-3F7F6AD4DFD8.dita">Navi |
|
41 pane</xref>: common items (such as tabs) should perform a function |
|
42 that is obvious and clear. Common AVKON interaction does not change. |
|
43 However, it an application can assign an appropriate function to its |
|
44 Navi pane items. It is also possible not to assign any function where |
|
45 appropriate.</p></li> |
|
46 <li><p><xref href="GUID-314B1556-5CB5-4BCC-93C0-B22DB849D2D5.dita">Universal |
|
47 indicator pane</xref>: opens a pop-up with more information on <xref href="GUID-771AF721-E2D7-41C8-BF97-5BD30D1A28AD.dita">Status pane</xref> indicators. It always includes battery and signal indicators and |
|
48 a small digital clock. The user can tap any of those for more information. |
|
49 For each visible universal indicator, there is one row reserved in |
|
50 the pop-up for displaying the icon and a description text. The description |
|
51 text may also inform about the current status and/or it may be a link |
|
52 to a view in corresponding application. For example, a tap on "3 new |
|
53 messages" opens the relevant view from the messaging application, |
|
54 and "Bluetooth active" switches view to the Bluetooth settings. Content |
|
55 of the row is determined by the application originating the indicator. </p></li> |
|
56 <li><p>Clock in the home screen opens the Clock application.</p></li> |
|
57 </ul> |
|
58 <section id="GUID-681C48E1-D94F-4960-8BC4-DEB5C8B677DF"><title>Using the status pane |
|
59 in applications</title><p>The API to use for the status pane is the <xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html" scope="peer">Status pane API</xref>. For implementation information, |
|
60 see <xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3" scope="peer">Using the status pane API</xref>.</p><p>Use the Status |
|
61 pane API for the following tasks:</p><ul> |
41 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.1" scope="peer">Creating the status pane using a resource file</xref></p></li> |
62 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.1" scope="peer">Creating the status pane using a resource file</xref></p></li> |
42 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.2" scope="peer">Accessing the status pane</xref></p></li> |
63 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.2" scope="peer">Accessing the status pane</xref></p></li> |
43 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.3" scope="peer">Accessing controls in the status pane's subpanes</xref></p></li> |
64 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.3" scope="peer">Accessing controls in the status pane's subpanes</xref></p></li> |
44 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.4" scope="peer">Showing and hiding the status pane</xref></p></li> |
65 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.4" scope="peer">Showing and hiding the status pane</xref></p></li> |
45 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.5" scope="peer">Dynamically changing status pane layout </xref></p></li> |
66 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.5" scope="peer">Dynamically changing status pane layout </xref></p></li> |
46 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.6" scope="peer">Observing status pane events</xref></p></li> |
67 <li><p><xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html#Status_Pane_API_Specification.topic3.6" scope="peer">Observing status pane events</xref></p></li> |
47 </ul><p>Applications can define and modify the title and navi sub-panes. For |
68 </ul><p>Applications can define and modify the title and navi sub-panes. |
48 implementation information on the sub-panes in the status pane, see the following |
69 For implementation information on the sub-panes in the status pane, |
49 APIs:</p><ul> |
70 see the following APIs:</p><ul> |
50 <li><p>Title pane API for the title pane</p></li> |
71 <li><p>Title pane API for the title pane</p></li> |
51 <li><p><xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html" scope="peer">Navigation pane API</xref> for the navi pane</p></li> |
72 <li><p><xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html" scope="peer">Navigation pane API</xref> for the Navi pane</p></li> |
52 </ul><p>Use the method <xref href="GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5.dita#GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5/GUID-98441932-C5BD-3743-B98F-BC8B7C40D2DA"><apiname>CEikStatusPaneBase::IsAppOwned()</apiname></xref> in |
73 </ul><p><xref href="GUID-4B3EDBA0-8849-37DE-9693-4A2DB23A2101.dita"><apiname>CEikStatusPane</apiname></xref> is the interface through |
53 the class <xref href="GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5.dita#GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5/GUID-18905F65-84C6-3085-865C-489041B36886"><apiname>CEikStatusPaneBase::TPaneCapabilities()</apiname></xref> to test |
74 which applications use the status pane. Use the method <xref href="GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5.dita#GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5/GUID-98441932-C5BD-3743-B98F-BC8B7C40D2DA"><apiname>CEikStatusPaneBase::IsAppOwned()</apiname></xref> in the class <xref href="GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5.dita#GUID-DFA80461-F732-30E8-B76A-B04C58CC1DD5/GUID-18905F65-84C6-3085-865C-489041B36886"><apiname>CEikStatusPaneBase::TPaneCapabilities()</apiname></xref> to test whether the pane is owned by the application or the server. |
54 whether the pane is owned by the application or the server. Applications can |
75 Applications can only interact directly with application owned sub-panes.</p><p><draft-comment time="2008-05-23T11:14" translate="no"> Relationship between events/similar |
55 only interact directly with application owned subpanes.</p><p><xref href="GUID-4B3EDBA0-8849-37DE-9693-4A2DB23A2101.dita"><apiname>CEikStatusPane</apiname></xref> is |
76 for entire status pane and sub-panes: should be clearer on what's |
56 the interface through which applications use the status pane. This class synchronizes |
77 done where</draft-comment></p><p> The following options are available |
57 the status pane layout with the server side status pane object. To do this, |
78 for modifying the default behavior of the status pane: </p><ul> |
58 the method <xref href="GUID-4B3EDBA0-8849-37DE-9693-4A2DB23A2101.dita#GUID-4B3EDBA0-8849-37DE-9693-4A2DB23A2101/GUID-F5265585-3EE1-389F-ADF5-ADDDE96D0C28"><apiname>CEikStatusPane::ApplyCurrentSettingsL()</apiname></xref> must |
79 <li><p>Since the status pane is a compound control, it can be made |
59 be called whenever the owner application switches to the foreground. </p><p><draft-comment time="2008-05-23T11:14" translate="no">Relationship between events/similar for entire status |
80 visible or invisible like an other control with <xref href="GUID-B06F99BD-F032-3B87-AB26-5DD6EBE8C160.dita#GUID-B06F99BD-F032-3B87-AB26-5DD6EBE8C160/GUID-159A51CE-4AEF-367B-9182-F33489D08BE2"><apiname>CCoeControl::MakeVisible()</apiname></xref>. <xref href="GUID-B06F99BD-F032-3B87-AB26-5DD6EBE8C160.dita#GUID-B06F99BD-F032-3B87-AB26-5DD6EBE8C160/GUID-159A51CE-4AEF-367B-9182-F33489D08BE2"><apiname>CCoeControl::MakeVisible()</apiname></xref> can be called before |
60 pane and sub-panes: should be clearer on what's done where</draft-comment></p><p> The |
81 or after the control is activated. An example of a call to make the |
61 following options are available for modifying the default behavior of the |
82 status pane invisible is as follows: </p><codeblock xml:space="preserve">CEikStatusPane* sp = StatusPane();// Gets a pointer to the status pane in the UI controller |
62 status pane: </p><ul> |
|
63 <li><p>Since the status pane is a compound control, it can be made visible |
|
64 or invisible like an other control with <codeph>CCoeControl::MakeVisible()</codeph>. <codeph>CCoeControl::MakeVisible()</codeph> can |
|
65 be called before or after the control is activated. An example of a call to |
|
66 make the status pane invisible is as follows: </p><codeblock xml:space="preserve">CEikStatusPane* sp = StatusPane();// Gets a pointer to the status pane in the UI controller |
|
67 StatusPane()->MakeVisible(EFalse); //make pane invisible somewhere in your code</codeblock></li> |
83 StatusPane()->MakeVisible(EFalse); //make pane invisible somewhere in your code</codeblock></li> |
68 <li><p>Accessing and modifying controls inside the status pane.</p><p> The |
84 <li><p>Accessing and modifying controls inside the status pane.</p><p> The Status Pane API provides methods for accessing the status |
69 Status Pane API provides methods for accessing the status pane control and |
85 pane control and modifying the status pane layout. </p><p>If you |
70 modifying the status pane layout. </p><p>If you wish to modify panes within |
86 want to modify panes within the status pane, you need to get a pointer |
71 the status pane, you need to get a pointer to the status pane and then use |
87 to the status pane and then use one of the following classes and methods: </p><ul> |
72 one of the following classes and methods: </p><ul> |
88 <li><p><xref href="GUID-4368DC7C-366A-34D6-ADA2-E2931381BEEF.dita"><apiname>CAknTitlePane</apiname></xref> for the title sub-pane</p></li> |
73 <li><p><xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknTitlePane.html" format="application/java-archive"><codeph>CAknTitlePane</codeph></xref> for |
|
74 the title sub-pane</p></li> |
|
75 <li><p>Methods defined by the <xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html" scope="peer">Navigation pane API</xref> for accessing the navi sub-pane </p></li> |
89 <li><p>Methods defined by the <xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html" scope="peer">Navigation pane API</xref> for accessing the navi sub-pane </p></li> |
76 <li><p>The <xref format="html" href="specs/guides/Tabs_API_Specification/Tabs_API_Specification.html" scope="peer">Tabs API</xref> for accessing tabs in the navi sub-pane.</p></li> |
90 <li><p>The <xref format="html" href="specs/guides/Tabs_API_Specification/Tabs_API_Specification.html" scope="peer">Tabs API</xref> for accessing tabs in the navi sub-pane.</p></li> |
77 </ul></li> |
91 </ul></li> |
78 <li><p>Defining new resources for the status pane to override the default |
92 <li><p>Defining new resources for the status pane to override the |
79 behavior</p><p> Once you have defined your resources, you may need to use |
93 default behavior</p><p> Once you have defined your resources, you |
80 some of the status pane APIs to achieve the desired effect in your application. |
94 may need to use some of the status pane APIs to achieve the desired |
81 </p><p>For more information, see the <xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html" scope="peer">Status pane API</xref> and <xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html" scope="peer">Navigation pane API</xref> reference documentation. </p></li> |
95 effect in your application. </p><p>For more information, see the <xref format="html" href="specs/guides/Status_Pane_API_Specification/Status_Pane_API_Specification.html" scope="peer">Status pane API</xref> and <xref format="html" href="specs/guides/Navigation_Pane_API_Specification/Navigation_Pane_API_Specification.html" scope="peer">Navigation pane API</xref> reference documentation. |
82 <li><p>You can also derive your own classes from the available classes or |
96 </p></li> |
83 their base classes to customize your own controls. </p></li> |
97 <li><p>You can also derive your own classes from the available classes |
84 </ul></section> |
98 or their base classes to customize your own controls. </p></li> |
85 <example><p>For more information on the panes, refer the following:</p></example> |
99 </ul><p>For more information on the panes, refer the following:</p></section> |
86 </conbody><related-links id="GUID-0FBC10E3-6A44-4AB4-BD42-A23539C4F148"> |
100 </conbody><related-links id="GUID-0FBC10E3-6A44-4AB4-BD42-A23539C4F148"> |
87 <linklist><title>Related APIs</title> |
101 <linklist><title>Related APIs</title> |
88 <link format="html" href="specs/guides/Skins_API_Specification/Skins_API_Specification.html" scope="peer"><linktext>Skins API</linktext> |
102 <link format="html" href="specs/guides/Skins_API_Specification/Skins_API_Specification.html" scope="peer"><linktext>Skins API</linktext> |
89 <desc> for providing themes support for the status pane</desc> |
103 <desc> for providing themes support for the status pane</desc> |
90 </link> |
104 </link> |