CEikServStatusPane Class Reference

class CEikServStatusPane : public CEikStatusPaneBase

CEikServStatusPane is the server side version of the status pane. This will typically used to own sub panes that contains system wide information.

Inherits from

Public Member Functions
~CEikServStatusPane()
voidBlockServerStatusPaneRedrawsL()
TInt CurrentAppStatuspaneResourceId()
voidHandleResourceChange(TInt)
voidHandleShapeChangeL()
CEikServStatusPane *NewL(CEikonEnv &, RWindowGroup *, TInt)
voidPrepareForAppExit()
voidRedrawServerStatusPane()
voidSetBlankWinObserver(MEikStatusPaneObserver *)
voidSetCurrentAppStatuspaneResourceId(TInt)
voidSetFaded(TBool)
voidSwitchLayoutL(TInt)
Private Member Functions
CEikServStatusPane(CEikonEnv &, RWindowGroup *)
voidConstructL(TInt)
CEikStatusPaneModelBase *CreateModelL(TInt)
TBool IsApp()
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::MakeVisible(TBool)
CEikStatusPaneBase::OkToChangeStatusPaneNow()
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::SetDimmed(TBool)
CEikStatusPaneBase::SetFlags(TInt)
CEikStatusPaneBase::SetInitialUsedResourceId(TInt)
CEikStatusPaneBase::SetObserver(MEikStatusPaneObserver *)
CEikStatusPaneBase::SetStoreHandler(RWindow *,TBool)
CEikStatusPaneBase::SwapControlL(TPaneId,CCoeControl *)
CEikStatusPaneBase::WindowGroup()const
CEikStatusPaneBase::~CEikStatusPaneBase()
Inherited Enumerations
CEikStatusPaneBase:TDrawCmd
Public Attributes
CAknStatusPaneDataPublisher *iDataPublisher
Private Attributes
MEikStatusPaneObserver *iBlankWinObserver
TInt iCurrentAppStatuspaneResourceId
TBool iIsFaded
Inherited Attributes
CEikStatusPaneBase::iControls
CEikStatusPaneBase::iEikEnv
CEikStatusPaneBase::iFlags
CEikStatusPaneBase::iModel

Constructor & Destructor Documentation

CEikServStatusPane(CEikonEnv &, RWindowGroup *)

CEikServStatusPane(CEikonEnv &aEikEnv,
RWindowGroup *aParent
)[private]

C++ constructor.

Parameters

CEikonEnv & aEikEnvAn environment for creating controls and utility functions for manipulating them.
RWindowGroup * aParentPointer to the parent window group.

~CEikServStatusPane()

~CEikServStatusPane()

Destructor.

Member Functions Documentation

BlockServerStatusPaneRedrawsL()

voidBlockServerStatusPaneRedrawsL()

Not implemented, server side status pane redraw blocker is not used anymore.

ConstructL(TInt)

voidConstructL(TIntaCoreResId)[private]

Second-phase constructor.

Parameters

TInt aCoreResIdStatus pane core resource ID.

CreateModelL(TInt)

CEikStatusPaneModelBase *CreateModelL(TIntaCoreResId)const [private, virtual]

Creates a new model for the server side status pane.

Parameters

TInt aCoreResIdID for the status pane resource.

CurrentAppStatuspaneResourceId()

TInt CurrentAppStatuspaneResourceId()

Returns the current status pane layout resource ID of the application side status pane.

HandleResourceChange(TInt)

voidHandleResourceChange(TIntaType)[virtual]

Handles resource change events.

Parameters

TInt aTypeEvent type.

HandleShapeChangeL()

voidHandleShapeChangeL()const

Handles event caused by status pane shape change.

IsApp()

TBool IsApp()const [private, virtual]

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

NewL(CEikonEnv &, RWindowGroup *, TInt)

CEikServStatusPane *NewL(CEikonEnv &aEikEnv,
RWindowGroup *aParent,
TIntaCoreResId
)[static]

Two-phased constructor.

Parameters

CEikonEnv & aEikEnvAn environment for creating controls and utility functions for manipulating them.
RWindowGroup * aParentPointer to the parent window group.
TInt aCoreResIdStatus pane core resource ID.

PrepareForAppExit()

voidPrepareForAppExit()

Prepares the status pane for the application exit.

RedrawServerStatusPane()

voidRedrawServerStatusPane()

Redraws the server side status pane. Currently does nothing, as all status pane drawing happens on the application side.

SetBlankWinObserver(MEikStatusPaneObserver *)

voidSetBlankWinObserver(MEikStatusPaneObserver *aBlankWinObserver)

Sets the status pane observer for server side status pane. The observer is server side screen blanker, as there is no CAknAppUi.

Parameters

MEikStatusPaneObserver * aBlankWinObserver

SetCurrentAppStatuspaneResourceId(TInt)

voidSetCurrentAppStatuspaneResourceId(TIntaResourceId)

Sets the current status pane layout resource ID of the application side status pane.

Parameters

TInt aResourceIdResource ID to be set.

SetFaded(TBool)

voidSetFaded(TBoolaFaded)[virtual]

Not implemented, as fading is handled by Window Server and the Application Framework.

Parameters

TBool aFadedNot used.

SwitchLayoutL(TInt)

voidSwitchLayoutL(TIntaLayoutResourceId)[virtual]

Switches to the specified status pane layout.

The actual layout to which this method switches may not be the same as specified in aLayoutResourceId parameter. Eg. if landscape mode status pane layout is set with this method, while in portrait mode, it's mapped to the corresponding layout in the portrait mode. This should be noted when using CEikStatusPaneBase::CurrentLayoutResId().

From release 3.2 on the old status pane layouts are also mapped to the new layouts, ie. R_AVKON_STATUS_PANE_LAYOUT_USUAL -> R_AVKON_STATUS_PANE_LAYOUT_USUAL_EXT

R_AVKON_STATUS_PANE_LAYOUT_IDLE -> R_AVKON_STATUS_PANE_LAYOUT_IDLE_EXT

avkon.rsg
leave
KErrNotFound The specified layout does not exist in the status pane resource structures.

Parameters

TInt aLayoutResourceIdLayout resource ID. This must be one of the layouts identified in the status pane resource structures, otherwise the function leaves KErrNotFound.

Member Data Documentation

MEikStatusPaneObserver * iBlankWinObserver

MEikStatusPaneObserver *iBlankWinObserver[private]

Status pane observer, screen blanker.

TInt iCurrentAppStatuspaneResourceId

TInt iCurrentAppStatuspaneResourceId[private]

Current application side status pane layout resource ID.

CAknStatusPaneDataPublisher * iDataPublisher

CAknStatusPaneDataPublisher *iDataPublisher

Status pane data publisher for system controlled status pane data. Own.

TBool iIsFaded

TBool iIsFaded[private]

Not used.