|
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 --> <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"><concept id="GUID-771AF721-E2D7-41C8-BF97-5BD30D1A28AD" xml:lang="en"><title> Status |
|
10 pane</title><prolog><metadata><keywords></keywords></metadata></prolog><conbody> |
|
11 <p>The Status pane displays status information of the current application |
|
12 and state, as well as general information about the device status, such as |
|
13 signal strength and battery charge. It occupies the top part of the screen |
|
14 and comes in two variants: extended and small. The Status pane may also be |
|
15 totally left out in certain applications or situations.</p> |
|
16 <p>Extended Status pane is a development of the earlier standard Symbian Status |
|
17 pane that contained a Context pane. Context pane cannot be used |
|
18 any more.</p> |
|
19 <note><p>The status pane used in Idle is a modified extended Status pane. </p></note> |
|
20 <p>Small Status pane can be used in cases where it is imperative to maximize |
|
21 Main pane area (for example, Browser). </p> |
|
22 <p>The Status pane contains the following subpanes:</p> |
|
23 <ul> |
|
24 <li><p><xref href="GUID-66EFFCF5-581A-4EE7-B784-8087A1081B6D.dita">Title pane</xref></p></li> |
|
25 <li><p><xref href="GUID-76FD2A71-E8A3-4C82-9704-3F7F6AD4DFD8.dita">Navi pane</xref></p></li> |
|
26 <li><p><xref href="GUID-DF3F2FD0-FF68-4CEF-843F-CBC9E84F3A7F.dita">Signal pane</xref></p></li> |
|
27 <li><p><xref href="GUID-A947B5A8-9138-4FA2-B8D8-2850AEB2F38C.dita">Battery pane</xref></p></li> |
|
28 <li><p><xref href="GUID-314B1556-5CB5-4BCC-93C0-B22DB849D2D5.dita">Universal indicator |
|
29 pane</xref></p></li> |
|
30 <li><p>Digital clock</p></li> |
|
31 </ul> |
|
32 <fig id="GUID-CD56E0F0-76CE-4F3E-92E7-6CF2125B9767"> |
|
33 <title>Status pane areas</title> |
|
34 <image href="GUID-D0FE1B14-706E-4E4D-902E-AB2B25F02464_d0e53018_href.png" scale="70" placement="inline"></image> |
|
35 </fig> |
|
36 <section id="GUID-681C48E1-D94F-4960-8BC4-DEB5C8B677DF"><title>Using |
|
37 the status pane in C++ applications</title><p>The API to use for the status |
|
38 pane is the Status |
|
39 pane API. For implementation information, see Using |
|
40 the status pane API.</p><p>Use the Status pane API for the following |
|
41 tasks:</p><ul> |
|
42 <li><p>Creating |
|
43 the status pane using a resource file</p></li> |
|
44 <li><p>Accessing |
|
45 the status pane</p></li> |
|
46 <li><p>Accessing |
|
47 controls in the status pane's subpanes</p></li> |
|
48 <li><p>Showing |
|
49 and hiding the status pane</p></li> |
|
50 <li><p>Dynamically |
|
51 changing status pane layout </p></li> |
|
52 <li><p>Observing |
|
53 status pane events</p></li> |
|
54 </ul><p>Applications can define and modify the title and navi subpanes. For |
|
55 implementation information on the subpanes in the status pane, see the following |
|
56 APIs:</p><ul> |
|
57 <li><p>Title |
|
58 pane API for the title pane</p></li> |
|
59 <li><p>Navigation |
|
60 pane API for the navi pane</p></li> |
|
61 </ul><p>Use the method <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikStatusPaneBase_1_1TPaneCapabilities.html#bc5c25636d87ce1eaa38fc294336bdd5" format="application/java-archive"><codeph>IsAppOwned()</codeph></xref> in the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikStatusPaneBase_1_1TPaneCapabilities.html" format="application/java-archive"><codeph>CEikStatusPaneBase::TPaneCapabilities</codeph></xref> to test whether |
|
62 the pane is owned by the application or the server. Applications can only |
|
63 interact directly with application owned subpanes.</p><p><xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikStatusPane.html" format="application/java-archive"><codeph>CEikStatusPane</codeph></xref> is the interface through which applications |
|
64 use the status pane. This class synchronises the status pane layout with the |
|
65 server side status pane object. To do this, the method <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikStatusPane.html#2d082d2526d324f9c153da7ffde9651c" format="application/java-archive"><codeph>ApplyCurrentSettingsL()</codeph></xref> must be called whenever the |
|
66 owner application switches to the foreground. </p><p><draft-comment translate="no" time="2008-05-23T11:14">Relationship |
|
67 between events/similar for entire status pane and subpanes: should be clearer |
|
68 on what's done where</draft-comment></p><p> The following options are available |
|
69 for modifying the default behavior of the status pane: </p><ul> |
|
70 <li><p>Since the status pane is a compound control, it can be made visible |
|
71 or invisible like an other control with <codeph>CCoeControl::MakeVisible()</codeph>. <codeph>CCoeControl::MakeVisible()</codeph> can |
|
72 be called before or after the control is activated. An example of a call to |
|
73 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 |
|
74 StatusPane()->MakeVisible(EFalse); //make pane invisible somewhere in your code</codeblock></li> |
|
75 <li><p>Accessing and modifying controls inside the status pane.</p><p> The |
|
76 Status Pane API provides methods for accessing the status pane control and |
|
77 modifying the status pane layout. </p><p>If you wish to modify panes within |
|
78 the status pane, you need to get a pointer to the status pane and then use |
|
79 one of the following classes and methods: </p><ul> |
|
80 <li><p><xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknTitlePane.html" format="application/java-archive"><codeph>CAknTitlePane</codeph></xref> for |
|
81 the title subpane</p></li> |
|
82 <li><p>Methods defined by the Navigation |
|
83 pane API for accessing the navi subpane </p></li> |
|
84 <li><p>The Tabs |
|
85 API for accessing tabs in the navi subpane.</p></li> |
|
86 </ul></li> |
|
87 <li><p>Defining new resources for the status pane to override the default |
|
88 behavior</p><p> Once you have defined your resources, you may need to use |
|
89 some of the status pane APIs to achieve the desired effect in your application. |
|
90 </p><p>For more information, see the Status |
|
91 pane API and Navigation |
|
92 pane API reference documentation. </p></li> |
|
93 <li><p>You could also possibly derive your own classes from the available |
|
94 classes or their base classes to customize your own controls. </p></li> |
|
95 </ul></section> |
|
96 </conbody></concept> |