CEikStatusPaneModelBase Class Reference

#include <mw/eikspmod.h>

class CEikStatusPaneModelBase : public CBase

Inherits from

CEikStatusPaneModelBase

Protected Member Type Definitions
typedef	CArrayFixFlat< TInt > CIdSet
typedef	CArrayPtrFlat< CIdLayoutPair > CLayoutIdSet

Protected Attributes
TInt	iCurrentResId
CEikonEnv &	iEikEnv
CLayoutIdSet *	iLayouts

Public Member Functions
	~CEikStatusPaneModelBase()
void	AknLayoutRefresh()
TBool	AknLayoutUsed(TInt)
CEikStatusPaneLayout *	CurrentLayout()
IMPORT_C TInt	CurrentLayoutResId()
CEikStatusPaneSetInit *	PaneInits()
virtual IMPORT_C void	SetLayoutL(TInt, TBool)

Protected Member Functions
	CEikStatusPaneModelBase(CEikonEnv &)
IMPORT_C void	BaseConstructL(TInt)
TBool	IsLegalId(TInt)
CIdSet *	LegalIds()
IMPORT_C CEikStatusPaneLayout *	LoadLayoutL(TInt)
	NONSHARABLE_CLASS(CIdLayoutPair)

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()

Detailed Description

Base class for status pane model.

Member Type Definition Documentation

Typedef CIdSet

typedef CArrayFixFlat< TInt >

CIdSet

[protected]

Typedef CLayoutIdSet

typedef CArrayPtrFlat< CIdLayoutPair >

CLayoutIdSet

[protected]

Member Attribute Documentation

iCurrentResId

TInt

iCurrentResId

[protected]

iEikEnv

CEikonEnv &

iEikEnv

[protected]

iLayouts

CLayoutIdSet *

iLayouts

[protected]

Constructor & Destructor Documentation

CEikStatusPaneModelBase ( CEikonEnv & )

IMPORT_C

CEikStatusPaneModelBase

(

CEikonEnv &

aEikEnv

)

[protected]

Constructor.

Parameter	Description
aEikEnv	An environment for creating controls.

~CEikStatusPaneModelBase ( )

IMPORT_C

~CEikStatusPaneModelBase

(

)

Destructor.

Member Function Documentation

AknLayoutRefresh ( )

void

AknLayoutRefresh

(

)

Re-reads layout data for all existing layouts from AknLayout system. The data may have to be refreshed when e.g. screen resolution, orientation or language variant layout is changed on the fly.

Since: 2.8

AknLayoutUsed ( TInt )

TBool

AknLayoutUsed

(

TInt

aLayoutId

)

This method tells if given layout is using AknLayout system for placing and sizing the statuspane subpanes.

Since: 2.8

Parameter	Description
aLayoutId	Layout which layout type is wanted to be known.

Returns: ETrue if given layout has been initailized to use AknLayout. EFalse if the default statuspane layout system is in use.

BaseConstructL ( TInt )

IMPORT_C void

BaseConstructL

(

TInt

aCoreResId

)

[protected]

Base constructor for 2nd phase construction.

Parameter	Description
aCoreResId	Status pane core resource id.

CurrentLayout ( )

CEikStatusPaneLayout *

CurrentLayout

(

)

const [inline]

Gets the current layout.

Returns: The current layout.

CurrentLayoutResId ( )

IMPORT_C TInt

CurrentLayoutResId

(

)

const

Gets the current layout resource id.

Returns: The current layout resource id.

IsLegalId ( TInt )

TBool

IsLegalId

(

TInt

aLayoutResId

)

const [protected]

Checks if given layout id is allowed.

Parameter	Description
aLayoutResId	Layout id to be checked.

Returns: ETrue if given layout id is allowed.

LegalIds ( )

CIdSet *

LegalIds

(

)

const [protected, inline]

Returns set of legal layout ids.

Returns: Set of allowed status pane layout ids.

LoadLayoutL ( TInt )

IMPORT_C CEikStatusPaneLayout *

LoadLayoutL

(

TInt

aLayoutResId

)

[protected]

Loads given layout from resource.

Parameter	Description
aLayoutResId	Layout resource id.

NONSHARABLE_CLASS ( CIdLayoutPair )

NONSHARABLE_CLASS

(

CIdLayoutPair

)

[protected, inline]

Internal class to CEikStatusPaneModel, which ties layout resource IDs to layout structures.

PaneInits ( )

CEikStatusPaneSetInit *

PaneInits

(

)

const [inline]

Gets the pane inits of the status pane.

Returns: Pane inits.

SetLayoutL ( TInt, TBool )

IMPORT_C void	SetLayoutL	(	TInt	aLayoutResId,
			TBool	aChangeStatusPaneNow = ETrue
		)	[virtual]

Sets the status pane layout

Parameter	Description
aLayoutResId	Resource id of the status pane layout.
aChangeStatusPaneNow	A flag to indicate immediate status pane layout change.