Status Pane API SpecificationChanges in Status Pane API documentation
Changes in Status Pane API
PurposeThe status pane displays status information of the current application and state, as well as general information about the device status, e.g. the signal strength and battery charging. It occupies the top part of the screen. The status pane contains more sub panes. Status pane contents controls provide an API to change the content of the title, context and navigation panes. The status pane contains the following sub-panes:
Every application has its own status pane instance. Status pane and status pane contents controls are created by the application UI framework when an application is constructed. The status pane layout is read from AVKON resources. The layout resource contains also information about the control that is put inside the sub panes. API DescriptionStatus Pane API provides support for accessing the application’s status pane. Status pane contents controls are AVKON controls. Status pane contents controls are dependent of Symbian platform and AVKON UI services. The controls are inside the status pane framework. The status pane is divided in local application owned and global status pane server owned panes. Applications have direct API to the application owned panes. The status pane exists outside the current application’s client area. Each pane is a window owning control. This allows the panes to be tiled together, even though they belong to different processes. A container control is used to host the status control for each pane. Application owned panes are:
Status pane server owned panes are:
The whole status pane layout and behavior is controlled by the
For details on Application owned panes see the following documentations:
Use casesThe main use cases of the Status Pane API are:
API class structure
This diagram shows the relationships between the client application (
Each UI owns an instance of the status pane (through the application UI
factory mechanism) that contains the pane model and contents relevant to it.
There are common base classes for the status pane and its model, used by the
client applications and the server. Each status pane owns a set of
Related APIs
Related APIs
Status pane APIDefining status pane in resource file
The status panes’s resource definition describes the application’s status
pane properties. The resource contains also information about the control
that is put inside the sub panes. Status pane’s
Related APIs
Accessing status pane
When using Status Pane API, the first step is to access a pointer to the
application’s status pane by calling the
The status pane layout is read from AVKON resources.
Related APIs
Accessing a control inside status pane’s sub paneIn this example the title pane's text is changed. For checking if a pane is part of the layout, before accessing it, see Status pane layout and capabilities .
Related APIs
Modifying status pane visibilityStatus pane can be visible, or invisible, so this way the application can be set full screen.
Requesting status pane visibility is trivial.
Status pane layout and capabilitiesStatus pane layout can be changed dynamically. Based on the layout, status pane can be small, or defined with different controls, e.g. the signal strength and battery charging. There are some predefined status pane layouts:
This example changes the status pane to small layout. Checks if title pane
is the part of the current layout, and sets title text. Layouts are defined
in
avkon.hrh
.
Related APIs
Observing status pane events
Handling status pane events requires that the observing class must be derived
from
Note that
In the example,
Access the status pane, and set
The
Related APIs
Error handlingStatus Pane API uses standard Symbian platform error reporting mechanism. Possible panic circumstances and panic codes are indicated in class or method descriptions. Leaves and system wide error codes as function return values are used if the error is recoverable. A client application can handle these errors similarly as a normal Symbian platform application. |