Context Pane API Specification

1 Overview

Context pane is a pane on the application's Status pane. Application can set an image to be shown in the Context pane.

API category	public
API type	c++
Existed since	Legacy S60 0.9
API libraries	avkon.lib
Location	`/sf/mw/classicui/classicui_pub/context_pane_api`
Buildfiles	`/sf/mw/classicui/classicui_pub/context_pane_api/group/bld.inf`

1.1 Description

Context pane is a pane shown on the Status pane, which end-user applications can utilize to show some picture. It is a Framework API. The picture can be set from a pre-constructed CFbsBitmap or CEikImage , a bitmap file or a resource file.

1.1.1 Emulator support

This API is fully supported in the WINS/WINSCW emulator environment.

1.2 Changes

This API is an SDK API and available for all S60 versions. The document is valid from S60 release 5.0 onwards.

This API is valid for all S60 platforms.

1.3 Use Cases

Set a picture to be shown on the Context pane.

1.4 Class Structure

Summary of API classes and header files
Classes	Files

CAknContextPane /epoc32/include/mw/akncontext.h

CAknContextPane is contained in CEikStatusPane . It is inherited from CAknControl .

Diagram

2 Using The API

2.1 Set a picture to Context pane

The following code snippet shows how to set a picture to the Context pane.

CAknContextPane* contextPane = (CAknContextPane*)sp->ControlL(contextPaneUid);
contextPane->SetPicture(aBitmap, aMask);

2.2 Limitations of the API

CAknContextPane cannot be instantiated and inherited. It only can be used on the Status pane and retrieved from the Status pane as the following code snippet shows.

CAknContextPane* cp = (CAknContextPane *)
    sp->ControlL(TUid::Uid(EEikStatusPaneUidContext));