CEikStatusPane Class Reference

class CEikStatusPane : public CEikStatusPaneBase

Application side status pane class.

CEikStatusPane is the interface through which applications use the status pane. This class synchronises the status pane layout with the server side status pane object. To do this, the ApplyCurrentSettingsL() method must be called whenever the owner application switches to the foreground.

Inherits from

CEikStatusPane
- CEikStatusPaneBase
  - CBase

Public Member Functions
	~CEikStatusPane()
IMPORT_C void	ApplyCurrentSettingsL()
IMPORT_C void	HandleResourceChange(TInt)
IMPORT_C void	MakeVisible(TBool)
IMPORT_C CEikStatusPane *	NewL(CEikonEnv &, RWindowGroup *, TInt, TInt)
IMPORT_C TBool	OkToChangeStatusPaneNow()
IMPORT_C void	PrepareForAppExit()
IMPORT_C void	SetDimmed(TBool)
IMPORT_C void	SetFaded(TBool)

Private Member Functions
	CEikStatusPane(CEikonEnv &, RWindowGroup *, TInt)
void	ApplyCurrentFlags()
void	ConstructL(TInt)
CEikStatusPaneModelBase *	CreateModelL(TInt)
void	DoHandleLosingForegroundL()
void	HandleGainingForeground()
void	HandleLosingForeground()
void	HideAppPanes(TBool)
TBool	IsApp()
TInt	ReadInitialUsedResourceIdL(TInt, TInt)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CEikStatusPaneBase::BaseConstructL(TInt)
	CEikStatusPaneBase::CEikStatusPaneBase(CEikonEnv &,RWindowGroup *)
	CEikStatusPaneBase::CbaAreaBackgroundID()
	CEikStatusPaneBase::Clearer()
	CEikStatusPaneBase::CommonPrepareForAppExit()
	CEikStatusPaneBase::ContainerControlL(TPaneId)const
	CEikStatusPaneBase::ControlL(TPaneId)const
	CEikStatusPaneBase::CreatePaneL(const TEikStatusPaneInit &)
	CEikStatusPaneBase::CreatePanesL()
	CEikStatusPaneBase::Current()
	CEikStatusPaneBase::CurrentLayoutResId()const
	CEikStatusPaneBase::DataSubscriber()const
	CEikStatusPaneBase::DisableClearer(TBool)
	CEikStatusPaneBase::DoDrawNow(TDrawCmd)
	CEikStatusPaneBase::DrawNow()
	CEikStatusPaneBase::EnableTransparent(TBool)
	CEikStatusPaneBase::Find(TPaneId)const
	CEikStatusPaneBase::Flags()const
	CEikStatusPaneBase::GetShapeL(TRegion &,TBool,TBool)const
	CEikStatusPaneBase::IsDimmed()const
	CEikStatusPaneBase::IsFaded()const
	CEikStatusPaneBase::IsTransparent()const
	CEikStatusPaneBase::IsVisible()const
	CEikStatusPaneBase::OptimizeClearerWindowShape(TInt,TInt,TRegion &)
	CEikStatusPaneBase::PaneCapabilities(TPaneId)const
	CEikStatusPaneBase::PaneRectL(TPaneId)const
	CEikStatusPaneBase::Rect()const
	CEikStatusPaneBase::ReduceRect(TRect &)const
	CEikStatusPaneBase::ReportSizeChange()
	CEikStatusPaneBase::SetCbaAreaBackgroundID(const TAknsItemID &,CEikStatusPaneBase::TDrawCmd)
	CEikStatusPaneBase::SetFlags(TInt)
	CEikStatusPaneBase::SetInitialUsedResourceId(TInt)
	CEikStatusPaneBase::SetObserver(MEikStatusPaneObserver *)
	CEikStatusPaneBase::SetStoreHandler(RWindow *,TBool)
	CEikStatusPaneBase::SwapControlL(TPaneId,CCoeControl *)
	CEikStatusPaneBase::SwitchLayoutL(TInt)
	CEikStatusPaneBase::WindowGroup()const
	CEikStatusPaneBase::~CEikStatusPaneBase()

Inherited Enumerations
	CEikStatusPaneBase:TDrawCmd

Private Attributes
TInt	iAppDeclId
CAknDelayedForegroundObserver *	iDelayedForegroundObserver
TAny *	iSpare

Inherited Attributes
	CEikStatusPaneBase::iControls
	CEikStatusPaneBase::iEikEnv
	CEikStatusPaneBase::iFlags
	CEikStatusPaneBase::iModel

Constructor & Destructor Documentation

CEikStatusPane(CEikonEnv &, RWindowGroup *, TInt)

CEikStatusPane	(	CEikonEnv &	aEikEnv,
		RWindowGroup *	aParent,
		TInt	aAppStatusPaneModelId
	)	[private]

Default C++ constructor.

Parameters

CEikonEnv & aEikEnv	An environment for creating controls and utility functions for manipulating them.
RWindowGroup * aParent	Pointer to the parent window group.
TInt aAppStatusPaneModelId

~CEikStatusPane()

IMPORT_C

~CEikStatusPane

(

)

Destructor.

Member Functions Documentation

ApplyCurrentFlags()

void

ApplyCurrentFlags

(

)

[private]

Applies the current status pane flags.

ApplyCurrentSettingsL()

IMPORT_C void

ApplyCurrentSettingsL

(

)

Synchronises the server status pane layout with the application status pane.

ConstructL(TInt)

void

ConstructL

(

TInt

aCoreStatusPaneModelResId

)

[private]

Second-phase constructor.

Parameters

TInt aCoreStatusPaneModelResId

Status pane core resource ID.

CreateModelL(TInt)

CEikStatusPaneModelBase *

CreateModelL

(

TInt

aCoreResId

)

const [private, virtual]

Creates the application side status pane model.

Parameters

TInt aCoreResId

Status pane core resource ID.

DoHandleLosingForegroundL()

void

DoHandleLosingForegroundL

(

)

[private]

Handles foreground lose events.

HandleGainingForeground()

void

HandleGainingForeground

(

)

[private]

Handles foreground gain events.

HandleLosingForeground()

void

HandleLosingForeground

(

)

[private]

Handles foreground lose events.

HandleResourceChange(TInt)

IMPORT_C void

HandleResourceChange

(

TInt

aType

)

[virtual]

Handles changes in resources which are shared across the environment. This function responds to the changes in resources by propagating them to sub-parts of the status pane. From CEikStatusPaneBase.

Parameters

TInt aType

A message type.

HideAppPanes(TBool)

void

HideAppPanes

(

TBool

aHide

)

[private]

Hides all the sub-panes owned by the application side status pane.

Parameters

TBool aHide

IsApp()

TBool

IsApp

(

)

const [private, virtual]

Can be used to determine whether or not the status pane is on application side or server side.

ETrue

MakeVisible(TBool)

IMPORT_C void

MakeVisible

(

TBool

aVisible

)

[virtual]

Sets the visiblility of the status pane and its contents. From CEikStatusPaneBase.

Parameters

TBool aVisible

If ETrue the status pane and its contents are set visible.

NewL(CEikonEnv &, RWindowGroup *, TInt, TInt)

IMPORT_C CEikStatusPane *	NewL	(	CEikonEnv &	aEikEnv,
			RWindowGroup *	aParent,
			TInt	aCoreStatusPaneModelResId,
			TInt	aAppStatusPaneModelResId = EEikStatusPaneUseDefaults
		)	[static]

Two-phased constructor.

Pointer to the created CEikStatusPane object.

Parameters

CEikonEnv & aEikEnv	An environment for creating controls and utility functions for manipulating them.
RWindowGroup * aParent	Pointer to the parent window group.
TInt aCoreStatusPaneModelResId	Status pane core resource ID.
TInt aAppStatusPaneModelResId = EEikStatusPaneUseDefaults	Resource ID of the application's status pane.

OkToChangeStatusPaneNow()

IMPORT_C TBool

OkToChangeStatusPaneNow

(

)

[virtual]

Returns always ETrue. From CEikStatusPaneBase.

ETrue.

PrepareForAppExit()

IMPORT_C void

PrepareForAppExit

(

)

Prepares the status pane for the application exit. Clears the status pane.

ReadInitialUsedResourceIdL(TInt, TInt)

TInt	ReadInitialUsedResourceIdL	(	TInt	aCoreResId,
			TInt	aAppStatusPaneModelResId
		)	[private]

Reads the initial status pane layout from the status pane resources.

Parameters

TInt aCoreResId	Status pane core resource ID.
TInt aAppStatusPaneModelResId	Resource ID specified by the application.

SetDimmed(TBool)

IMPORT_C void

SetDimmed

(

TBool

aDimmed

)

[virtual]

Sets the status pane and its contents to dimmed state. From CEikStatusPaneBase.

Parameters

TBool aDimmed

If ETrue the status pane and its contents are set to dimmed state.

SetFaded(TBool)

IMPORT_C void

SetFaded

(

TBool

aFaded

)

[virtual]

Not implemented. From CEikStatusPaneBase.

Parameters

TBool aFaded

Not used.

Member Data Documentation

TInt iAppDeclId

TInt

iAppDeclId

[private]

CAknDelayedForegroundObserver * iDelayedForegroundObserver

CAknDelayedForegroundObserver *

iDelayedForegroundObserver

[private]

Formerly iServerSpWgId

TAny * iSpare

TAny *

iSpare

[private]

Formerly TEikStatusPaneSyncDrawer* iSyncDrawer