CEikStatusPaneLayout Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikspmod.h>

Detailed Description

This class calculates and stores the screen area available for each sub pane layout.


Public Member Functions
	~CEikStatusPaneLayout ()
	Destructor.
CEikStatusPaneLayoutTree *	Find (const TPaneId &aPaneId) const
	Finds the pane init with a given id.
void	AcceptL (MEikStatusPaneLayoutTreeVisitor *aVisitor)
	Calls given visitor objects VisitL, method.
TRect	Rect () const
	Gets rectagle of the sub pane layout.
void	AknLayoutRefresh (TInt aLayoutResourceId)
	Re-reads layout data from AknLayout system.
TBool	AknLayoutUsed ()
	This method tells if this layout is using AknLayout system for placing and sizing the statuspane subpanes.
TRect	AknLayoutRect (TInt aLayoutResourceId, TPaneId aPaneId)
	This method maps given layout resource id and subpane UID to correct layout lines in the AknLayout system.
Static Public Member Functions
static CEikStatusPaneLayout *	NewL (TResourceReader &aResource, const TRect &aScreenRect)
	Two phase constructor.
static CEikStatusPaneLayout *	NewL (TResourceReader &aResource, const TRect &aScreenRect, TInt aLayoutId)
	Two phase constructor.
Friends
class	CEikStatusPaneLayoutTree

Constructor & Destructor Documentation

CEikStatusPaneLayout::~CEikStatusPaneLayout

(

)

Destructor.

Member Function Documentation

void CEikStatusPaneLayout::AcceptL ( MEikStatusPaneLayoutTreeVisitor * aVisitor ) [inline]

Calls given visitor objects VisitL, method.

Parameters:

aVisitor

A visitor object to be visited.

TRect CEikStatusPaneLayout::AknLayoutRect	(	TInt	aLayoutResourceId,
		TPaneId	aPaneId
	)

This method maps given layout resource id and subpane UID to correct layout lines in the AknLayout system.

Parameters:

	aLayoutResourceId	Id of a statuspane layout.
	aPaneId	Uid of a statuspane subpane.

Returns:: A rectangle which specifies the given subpane size and position in the given layout.

void CEikStatusPaneLayout::AknLayoutRefresh

Re-reads layout data 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.

Parameters:

aLayoutResourceId

Id of the statuspane layout which data is to be refreshed.

TBool CEikStatusPaneLayout::AknLayoutUsed

(

)

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

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

CEikStatusPaneLayoutTree * CEikStatusPaneLayout::Find ( const TPaneId & aPaneId ) const [inline]

Finds the pane init with a given id.

If a pane init is not found NULL pointer is returned.

Returns:: The layout tree instance with given id.

static CEikStatusPaneLayout* CEikStatusPaneLayout::NewL	(	TResourceReader &	aResource,
		const TRect &	aScreenRect,
		TInt	aLayoutId
	)	`[static]`

Two phase constructor.

Parameters:

	aResource	Resource of sub pane layout.
	aScreenRect	Screen rectangle.
	aLayoutId	Id of the status pane layout.

static CEikStatusPaneLayout* CEikStatusPaneLayout::NewL	(	TResourceReader &	aResource,
		const TRect &	aScreenRect
	)	`[static]`

Two phase constructor.

Parameters:

	aResource	Resource of sub pane layout.
	aScreenRect	Screen rectangle.

TRect CEikStatusPaneLayout::Rect ( ) const [inline]

Gets rectagle of the sub pane layout.

Returns:: Rectangle of the sub pane layout.

Friends And Related Function Documentation

friend class CEikStatusPaneLayoutTree [friend]

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

eikspmod.h

CEikStatusPaneLayout Class Reference

Capability Information

Detailed Description

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation