CAknContextPane Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akncontext.h>

Inherits CAknControl.

Detailed Description

A default control in the status pane's context pane.


Public Member Functions
IMPORT_C void	ConstructL ()
	2nd phase construction
IMPORT_C void	ConstructFromResourceL (TResourceReader &aReader)
	Construct from resources.
IMPORT_C void	SetPicture (const CFbsBitmap aBitmap, const CFbsBitmap aMaskBitmap=NULL)
	Sets bitmap with mask to the context pane and shows it in the status pane's context pane.
IMPORT_C void	SetPicture (CEikImage *aImage)
	Sets bitmap to the context pane and shows it in the status pane's context pane.
IMPORT_C void	SetPictureFromFileL (const TDesC &aFileName, TInt aMainId, TInt aMaskId=-1)
	Sets bitmap to the context pane from file and shows it in the status pane's context pane.
IMPORT_C void	SetFromResourceL (TResourceReader &aReader)
	Set data from resource file and show it in the status pane's context pane.
IMPORT_C void	SetPictureToDefaultL ()
	Show context pane's default bitmap.
IMPORT_C const CEikImage &	Picture () const
	Returns a reference to the current context pane bitmap.
IMPORT_C CEikImage *	SwapPicture (CEikImage *aNewImage)
	Sets bitmap with mask to the context pane and shows it in the status pane's context pane.
void	SetNaviPaneBackgroundType (TInt aType)
	Set the background type.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From CCoeControl.
Data Fields
DECLARE_TYPE_ID(0x101F8741) public IMPORT_	~CAknContextPane )()
	Destructor.
Protected Member Functions
virtual IMPORT_C void	SizeChanged ()
	From CCoeControl.
virtual IMPORT_C void	HandleResourceChange (TInt aType)
	Handles a change to the control's resources of type aType which are shared across the environment, e.g.
virtual IMPORT_C TInt	CountComponentControls () const
	From CCoeControl.
virtual IMPORT_C CCoeControl *	ComponentControl (TInt aIndex) const
	From CCoeControl.
TTypeUid::Ptr	MopSupplyObject (TTypeUid aId)

Member Function Documentation

virtual IMPORT_C CCoeControl* CAknContextPane::ComponentControl ( TInt aIndex ) const [protected, virtual]

From CCoeControl.

Returns a control determined by control id.

Parameters:

anIndex

Index of a control to be returned.

Returns:: Pointer to control

IMPORT_C void CAknContextPane::ConstructFromResourceL

Construct from resources.

Parameters:

aReader

resource reader.

IMPORT_C void CAknContextPane::ConstructL

(

)

2nd phase construction

virtual IMPORT_C TInt CAknContextPane::CountComponentControls ( ) const [protected, virtual]

From CCoeControl.

Returns number of controls inside the context pane control.

Returns:: Number of component controls.

IMPORT_C void CAknContextPane::HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

From CCoeControl.

Handles pointer events

virtual IMPORT_C void CAknContextPane::HandleResourceChange ( TInt aType ) [protected, virtual]

Handles a change to the control's resources of type aType which are shared across the environment, e.g.

color scheme change.

Parameters:

aType

Event type.

TTypeUid::Ptr CAknContextPane::MopSupplyObject ( TTypeUid aId ) [protected]

IMPORT_C const CEikImage& CAknContextPane::Picture

(

)

const

Returns a reference to the current context pane bitmap.

The reference is lost when context pane bitmap is changed with any Set -method including SetPictureToDefaultL and SwapPicture)

Returns:: Reference to the current context pane bitmap.

IMPORT_C void CAknContextPane::SetFromResourceL

Set data from resource file and show it in the status pane's context pane.

void CAknContextPane::SetNaviPaneBackgroundType

Set the background type.

This method is used by the UI framework for for syncronizing this components background type with navipane background type.

Available backgroud types are: EAknNaviPaneBackgroundTypeNotDefined EAknNaviPaneBackgroundTypeWipe EAknNaviPaneBackgroundTypeSolid

Parameters:

aType

Background type.

IMPORT_C void CAknContextPane::SetPicture

Sets bitmap to the context pane and shows it in the status pane's context pane.

Context pane object takes ownership of the bitmap.

Parameters:

aImage

new bitmap and its mask.

IMPORT_C void CAknContextPane::SetPicture	(	const CFbsBitmap *	aBitmap,
		const CFbsBitmap *	aMaskBitmap = `NULL`
	)

Sets bitmap with mask to the context pane and shows it in the status pane's context pane.

Context pane object takes ownership of the bitmap.

Parameters:

	aBitmap	new bitmap to the context pane.
	aMaskBitmap	mask of the bitmap.

IMPORT_C void CAknContextPane::SetPictureFromFileL	(	const TDesC &	aFileName,
		TInt	aMainId,
		TInt	aMaskId = `-1`
	)

Sets bitmap to the context pane from file and shows it in the status pane's context pane.

Parameters:

	aFileName	name of the bitmap file.
	aMainId	id of the bitmap in the bitmap file.
	aMaskId	id of the bitmap's mask in the bitmap file.

IMPORT_C void CAknContextPane::SetPictureToDefaultL

(

)

Show context pane's default bitmap.

Application's AIF file icon is used if it exists.

virtual IMPORT_C void CAknContextPane::SizeChanged ( ) [protected, virtual]

From CCoeControl.

Handle the size change events.

IMPORT_C CEikImage* CAknContextPane::SwapPicture

Sets bitmap with mask to the context pane and shows it in the status pane's context pane.

Context pane object takes ownership of the bitmap. Old bitmap is returned and the caller is responsible of deleting the returned object.

Parameters:

aNewImage

new bitmap to the context pane. This object takes ownership of aNewImage.

Returns:: Previous context pane bitmap. The caller is responsible of deleting the returned object.

Field Documentation

DECLARE_TYPE_ID (0x101F8741) public IMPORT_ CAknContextPane::~CAknContextPane)()

Destructor.

The documentation for this class was generated from the following file:

akncontext.h

CAknContextPane Class Reference

Capability Information

Detailed Description

Public Member Functions

Data Fields

Protected Member Functions

Member Function Documentation

Field Documentation