Collapse all Symbian^3 Product Developer Library

CAknsSrvChunkLookup Class Reference

class CAknsSrvChunkLookup : public CBase

A class for looking up and creating item definitions stored in the shared memory chunk.

Since: 2.0

Inherits from

CAknsSrvChunkLookup
- CBase

Public Member Functions
	~CAknsSrvChunkLookup()
void	BeginRead()
IMPORT_C void	BeginRender()
void	EndRead()
IMPORT_C void	EndRender()
IMPORT_C CAknsItemDef *	LookupAndCreateDefL(const TAknsItemID &)
IMPORT_C void	LookupAndCreateScalableItemL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap &, CFbsBitmap &, TInt &)
CAknsSrvChunkLookup *	NewL()

Protected Member Functions
	CAknsSrvChunkLookup()
void	ConstructL()
CAknsAnimationItemDef *	CreateAnimationL(const TAknsItemID &, const TAny , const TAny )
CAknsEffectItemDef *	CreateEffectL(const TUint8 , const TBool, const TAny )
TUint32	CreateEffectL(CAknsEffectItemDef &, const TUint32, const TAny , const TAny *, const TBool)
CAknsEffectQueueItemDef *	CreateEffectQueueL(const TAknsItemID &, const TAny , const TAny )
CAknsEffectParamDef *	CreateParameterL(const TUint8 , const TAny )
TUint32	CreateParameterL(CAknsEffectParamDef &, const TUint32, const TAny , const TAny *)
CAknsItemDef *	CreateUnprotectedL(const TAknsItemID &, const TAny , const TAknsItemType, const TAny )
void	LookupAndCreateScalableItemUnprotectedL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap &, CFbsBitmap &, TInt &)

Private Member Functions
IMPORT_C TInt	Reserved()

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

Private Attributes
RMutex	iRenderMutex
RChunk	iSharedChunk
RSemaphore	iWaitSema

Constructor & Destructor Documentation

CAknsSrvChunkLookup()

CAknsSrvChunkLookup

(

)

[protected]

Default C++ constructor

~CAknsSrvChunkLookup()

~CAknsSrvChunkLookup

(

)

[virtual]

Default C++ destructor.

Member Functions Documentation

BeginRead()

void

BeginRead

(

)

Blocks write access to the shared memory chunk.

Since: 2.0

BeginRender()

IMPORT_C void

BeginRender

(

)

Blocks all rendering.

Since: 2.8

ConstructL()

void

ConstructL

(

)

[protected]

Second-phase constructor.

CreateAnimationL(const TAknsItemID &, const TAny , const TAny )

CAknsAnimationItemDef *	CreateAnimationL	(	const TAknsItemID &	aID,
			const TAny *	aDefPtr,
			const TAny *	aBasePtr
		)	[protected]

Since: 3.0

Parameters

const TAknsItemID & aID
const TAny * aDefPtr
const TAny * aBasePtr

CreateEffectL(const TUint8 , const TBool, const TAny )

CAknsEffectItemDef *	CreateEffectL	(	const TUint8 *	aData,
			const TBool	aIsAnimationCommand,
			const TAny *	aBasePtr
		)	[protected]

Since: 3.0

Parameters

const TUint8 * aData
const TBool aIsAnimationCommand
const TAny * aBasePtr

CreateEffectL(CAknsEffectItemDef &, const TUint32, const TAny , const TAny *, const TBool)

TUint32	CreateEffectL	(	CAknsEffectItemDef *&	aDef,
			const TUint32	aOffset,
			const TAny *	aDefPtr,
			const TAny *	aBasePtr,
			const TBool	aIsAnimationCommand
		)	[protected]

Since: 3.0

Parameters

CAknsEffectItemDef *& aDef
const TUint32 aOffset
const TAny * aDefPtr
const TAny * aBasePtr
const TBool aIsAnimationCommand

CreateEffectQueueL(const TAknsItemID &, const TAny , const TAny )

CAknsEffectQueueItemDef *	CreateEffectQueueL	(	const TAknsItemID &	aID,
			const TAny *	aDefPtr,
			const TAny *	aBasePtr
		)	[protected]

Since: 3.0

Parameters

const TAknsItemID & aID
const TAny * aDefPtr
const TAny * aBasePtr

CreateParameterL(const TUint8 , const TAny )

CAknsEffectParamDef *	CreateParameterL	(	const TUint8 *	aData,
			const TAny *	aBasePtr
		)	[protected]

Since: 3.0

Parameters

const TUint8 * aData
const TAny * aBasePtr

CreateParameterL(CAknsEffectParamDef &, const TUint32, const TAny , const TAny *)

TUint32	CreateParameterL	(	CAknsEffectParamDef *&	aDef,
			const TUint32	aOffset,
			const TAny *	aDefPtr,
			const TAny *	aBasePtr
		)	[protected]

Since: 3.0

Parameters

CAknsEffectParamDef *& aDef
const TUint32 aOffset
const TAny * aDefPtr
const TAny * aBasePtr

CreateUnprotectedL(const TAknsItemID &, const TAny , const TAknsItemType, const TAny )

CAknsItemDef *	CreateUnprotectedL	(	const TAknsItemID &	aID,
			const TAny *	aDef,
			const TAknsItemType	aType,
			const TAny *	aBasePtr
		)	[protected]

Creates an item definition object (or leaves) based on the given item definition structure.

Note that this method does not use the semaphore, and is therefore unprotected.

Since: 2.0

Parameters

const TAknsItemID & aID	Item ID of the item.
const TAny * aDef	Pointer to the definition.
const TAknsItemType aType	Type of the definition.
const TAny * aBasePtr	Chunk base pointer.

EndRead()

void

EndRead

(

)

Allows write access to the shared memory chunk.

Since: 2.0

EndRender()

IMPORT_C void

EndRender

(

)

Allows rendering.

Since: 2.8

LookupAndCreateDefL(const TAknsItemID &)

IMPORT_C CAknsItemDef *

LookupAndCreateDefL

(

const TAknsItemID &

aID

)

Returns item definition object matching the given item ID. Performs lookup for the given item ID and returns an instance of one of the subclasses of CAknsItemDef matching the given ID. If the call is successfull, ownership of the item definition object is transferred to the caller.

Since: 2.0

Exceptions:: If construction of the item definition object failed, method leaves with an error code.

Parameters

const TAknsItemID & aID

Item ID to be searched.

LookupAndCreateScalableItemL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap &, CFbsBitmap &, TInt &)

IMPORT_C void	LookupAndCreateScalableItemL	(	const TAknsItemID &	aID,
			const TInt	aLayout,
			const TSize &	aLayoutSize,
			CFbsBitmap *&	aBitmap,
			CFbsBitmap *&	aMask,
			TInt &	aMorphing
		)

Returns stored scalable bitmaps and optionally its mask if it was stored. The ownership of the returned bitmap (and mask, if any) is transferred to the caller.

Optionally, the caller can give the current copy of the bitmap and mask as aBitmap and aMask parameters. If the currently stored scalable bitmaps have the same handles, they are not re-duplicated. The ownership of the given bitmaps is transferred to chunk lookup.

Since: 2.8

Parameters

const TAknsItemID & aID	Item ID to be searched.
const TInt aLayout	The layout id type for the searhed item.
const TSize & aLayoutSize
CFbsBitmap *& aBitmap	Current bitmap or NULL. Ownership is transferred. After return, contains the newly duplicated bitmap, or NULL if not found. Ownership is transferred.
CFbsBitmap *& aMask	Current mask or NULL. Ownership is transferred. After return, contains the newly duplicated mask, or NULL if not found. Ownership is transferred.
TInt & aMorphing

LookupAndCreateScalableItemUnprotectedL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap &, CFbsBitmap &, TInt &)

void	LookupAndCreateScalableItemUnprotectedL	(	const TAknsItemID &	aID,
			const TInt	aLayout,
			const TSize &	aLayoutSize,
			CFbsBitmap *&	aBitmap,
			CFbsBitmap *&	aMask,
			TInt &	aMorphing
		)	[protected]

Returns stored scalable bitmaps and optionally its mask if it was stored.

Note that this method does not use the semaphore, and is therefore unprotected.

Since: 2.8

Parameters

const TAknsItemID & aID
const TInt aLayout
const TSize & aLayoutSize
CFbsBitmap *& aBitmap
CFbsBitmap *& aMask
TInt & aMorphing

NewL()

CAknsSrvChunkLookup *

NewL

(

)

[static]

SymbianOS two-phased constructor.

Since: 2.0

Exceptions:: If the construction fails, the leaves with one of the system wide error codes.

Reserved()

IMPORT_C TInt

Reserved

(

)

[private]

Reserved for future use.

Since: 2.0

Member Data Documentation

RMutex iRenderMutex

RMutex

iRenderMutex

[private]

RChunk iSharedChunk

RChunk

iSharedChunk

[private]

RSemaphore iWaitSema

RSemaphore

iWaitSema

[private]

CAknsSrvChunkLookup Class Reference

Inherits from

Constructor & Destructor Documentation

CAknsSrvChunkLookup()

~CAknsSrvChunkLookup()

Member Functions Documentation

BeginRead()

BeginRender()

ConstructL()

CreateAnimationL(const TAknsItemID &, const TAny *, const TAny *)

Parameters

CreateEffectL(const TUint8 *, const TBool, const TAny *)

Parameters

CreateEffectL(CAknsEffectItemDef *&, const TUint32, const TAny *, const TAny *, const TBool)

Parameters

CreateEffectQueueL(const TAknsItemID &, const TAny *, const TAny *)

Parameters

CreateParameterL(const TUint8 *, const TAny *)

Parameters

CreateParameterL(CAknsEffectParamDef *&, const TUint32, const TAny *, const TAny *)

Parameters

CreateUnprotectedL(const TAknsItemID &, const TAny *, const TAknsItemType, const TAny *)

Parameters

EndRead()

EndRender()

LookupAndCreateDefL(const TAknsItemID &)

Parameters

LookupAndCreateScalableItemL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap *&, CFbsBitmap *&, TInt &)

Parameters

LookupAndCreateScalableItemUnprotectedL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap *&, CFbsBitmap *&, TInt &)

Parameters

NewL()

Reserved()

Member Data Documentation

RMutex iRenderMutex

RChunk iSharedChunk

RSemaphore iWaitSema

CreateAnimationL(const TAknsItemID &, const TAny , const TAny )

CreateEffectL(const TUint8 , const TBool, const TAny )

CreateEffectL(CAknsEffectItemDef &, const TUint32, const TAny , const TAny *, const TBool)

CreateEffectQueueL(const TAknsItemID &, const TAny , const TAny )

CreateParameterL(const TUint8 , const TAny )

CreateParameterL(CAknsEffectParamDef &, const TUint32, const TAny , const TAny *)

CreateUnprotectedL(const TAknsItemID &, const TAny , const TAknsItemType, const TAny )

LookupAndCreateScalableItemL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap &, CFbsBitmap &, TInt &)

LookupAndCreateScalableItemUnprotectedL(const TAknsItemID &, const TInt, const TSize &, CFbsBitmap &, CFbsBitmap &, TInt &)