Status Pane API Specification

Contents 1 Overview 1.1 Description 1.2 Changes 1.3 Use Cases 1.4 Class Structure 2 Glossary 2.1 Abbreviations 2.2 Definitions

1 Overview

The 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:

• Title pane
• Context pane
• Navigation pane
• Signal pane
• Battery pane/universal indicator pane

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 category	public
API type	c++
Existed since	Legacy S60 0.9
API libraries	eikcoctl.lib
Location	/sf/mw/classicui/classicui_pub/status_pane_api
Buildfiles	/sf/mw/classicui/classicui_pub/status_pane_api/group/bld.inf

1.1 Description

Status 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 OS 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:

• the title pane.
• the context pane.
• the navigation pane.

Status pane server owned panes are:

• the signal pane.
• the battery pane.
• the indicator pane.
• the Idle layout context pane.

The whole status pane layout and behavior is controlled by the CEikStatusPaneBase class. The status pane base class contains a status pane container to every pane. Every container owns one status pane control.

For details on Application owned panes see the following documentations:

• Title Pane API
• Context Pane API
• Navigation Pane API

1.2 Changes

Status Pane API is an SDK API and part of S60 release 3.x.

None.

1.3 Use Cases

The main use cases of the Status Pane API are:

• Defining status pane in resource file
• Accessing status pane control
• Accessing a control inside status pane's sub pane
• Modifying status pane visibility
• Changing status pane layout
• Observing status pane events

1.4 Class Structure

Summary of API classes and header files

Classes	Files

CEikAppStatusPaneModel /epoc32/include/mw/eikspmod.h CEikStatusPane /epoc32/include/mw/eikspane.h CEikStatusPaneBase /epoc32/include/mw/eikspane.h CEikStatusPaneBase::TPaneCapabilities /epoc32/include/mw/eikspane.h CEikStatusPaneBase::TSetRectAndVisibility /epoc32/include/mw/eikspane.h CEikStatusPaneLayout /epoc32/include/mw/eikspmod.h CEikStatusPaneLayoutTree /epoc32/include/mw/eikspmod.h CEikStatusPaneModelBase /epoc32/include/mw/eikspmod.h CEikStatusPaneModelBase::CIdLayoutPair /epoc32/include/mw/eikspmod.h CEikStatusPaneModelBase::TLayoutChecker /epoc32/include/mw/eikspmod.h CEikStatusPaneSetInit /epoc32/include/mw/eikspmod.h MEikStatusPaneLayoutTreeVisitor /epoc32/include/mw/eikspmod.h MEikStatusPaneObserver /epoc32/include/mw/eikspane.h TEikStatusPaneInit /epoc32/include/mw/eikspmod.h

This diagram shows the relationships between the client application ( CEikAppUi ), the UIKON server ( CEikServAppUi ), the status pane classes ( CEikStatusPaneBase , CEikStatusPane and CEikServStatusPane ) and the resource structure representations (the model classes).

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 CEikStatusPaneContainer controls, which hold the status pane indicator controls.

2 Glossary

2.1 Abbreviations

Status Pane API abbreviations

API	Application Programming Interface
AVKON	S60 extensions and modifications to Uikon and other parts of the Symbian OS application framework.

2.2 Definitions

Status Pane API definitions

Status pane

The 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.