CAknsLayeredBackgroundControlContext Class Reference

class CAknsLayeredBackgroundControlContext : public CAknsBasicBackgroundControlContext

Implementation of a control context that provides one or more layered backgrounds with their layout rectangles.

This is a public class with exported functions. The class is not intended for derivation outside the library.

AknSkins.lib

2.0

Inherits from

CAknsLayeredBackgroundControlContext
- CAknsBasicBackgroundControlContext
  - CBase

Public Member Functions
	~CAknsLayeredBackgroundControlContext()
TBool	IsCompatibleWithType(const TAknsControlContextType)
IMPORT_C CAknsLayeredBackgroundControlContext *	NewL(const TAknsItemID &, const TRect &, const TBool, const TInt)
IMPORT_C void	SetLayerImage(const TInt, const TAknsItemID &)
IMPORT_C void	SetLayerRect(const TInt, const TRect &)

Protected Member Functions
	CAknsLayeredBackgroundControlContext()
void	ConstructL(const TRect &, const TBool, const TAknsItemID &, const TInt)

Inherited Functions
	CAknsBasicBackgroundControlContext::CAknsBasicBackgroundControlContext()
	CAknsBasicBackgroundControlContext::ConstructL(const TRect &,TBool,const TAknsItemID &)
	CAknsBasicBackgroundControlContext::NewL(const TAknsItemID &,const TRect &,TBool)
	CAknsBasicBackgroundControlContext::SetBitmap(const TAknsItemID &)
	CAknsBasicBackgroundControlContext::SetParentContext(MAknsControlContext *)
	CAknsBasicBackgroundControlContext::SetParentPos(const TPoint &)
	CAknsBasicBackgroundControlContext::SetRect(const TRect &)
	CAknsBasicBackgroundControlContext::SupplySkinObject(TAknsCCObject)
	CAknsBasicBackgroundControlContext::SupplySkinParameter(TAknsCCParameter)
	CAknsBasicBackgroundControlContext::~CAknsBasicBackgroundControlContext()
	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()

Protected Attributes
TAknsBackground *	iLayoutArray
TInt	iLayoutArraySize

Inherited Attributes
	CAknsBasicBackgroundControlContext::iLayout
	CAknsBasicBackgroundControlContext::iParentContext

Constructor & Destructor Documentation

CAknsLayeredBackgroundControlContext()

CAknsLayeredBackgroundControlContext

(

)

[protected]

C++ constructor.

~CAknsLayeredBackgroundControlContext()

~CAknsLayeredBackgroundControlContext

(

)

[virtual]

Destructor.

Member Functions Documentation

ConstructL(const TRect &, const TBool, const TAknsItemID &, const TInt)

void	ConstructL	(	const TRect &	aRect,
			const TBool	aParentAbsolute,
			const TAknsItemID &	aImageID,
			const TInt	aNumberOfLayers
		)	[protected]

Symbian 2nd phase constructor.

Parameters

const TRect & aRect
const TBool aParentAbsolute
const TAknsItemID & aImageID
const TInt aNumberOfLayers

IsCompatibleWithType(const TAknsControlContextType)

TBool

IsCompatibleWithType

(

const TAknsControlContextType

aType

)

const

Determines whether this control context is compatible with the given derived type.

2.0

ETrue if this control context instance is compatible with the given type (i.e. can be casted to the corresponding concrete class). EFalse otherwise.

Parameters

const TAknsControlContextType aType

Type of the derived control context class (one of the values in TAknsControlContextType).

NewL(const TAknsItemID &, const TRect &, const TBool, const TInt)

IMPORT_C CAknsLayeredBackgroundControlContext *	NewL	(	const TAknsItemID &	aImageID,
			const TRect &	aRect,
			const TBool	aParentAbsolute,
			const TInt	aNumberOfLayers
		)	[static]

Two-phased constructor.

2.0

Newly constructed object.

Parameters

const TAknsItemID & aImageID	Item ID of the first background bitmap.
const TRect & aRect	Rectangle where the first bitmap should be laid out.
const TBool aParentAbsolute	ETrue if parent absolute layout should be used, EFalse otherwise. If a parent absolute layout is used, the parent position must be set and updated using SetParentPos.
const TInt aNumberOfLayers	Total number of layers as an integer. This must be 1 or more.

SetLayerImage(const TInt, const TAknsItemID &)

IMPORT_C void	SetLayerImage	(	const TInt	aLayer,
			const TAknsItemID &	aID
		)

Sets the item ID of the specified layer.

2.0

Parameters

const TInt aLayer	Index of the layer, where 0 is the first one. The index must be less than aNumberOfLayers given to NewL().
const TAknsItemID & aID	Item ID of the image.

SetLayerRect(const TInt, const TRect &)

IMPORT_C void	SetLayerRect	(	const TInt	aLayer,
			const TRect &	aRect
		)

Sets the layout rectangle of the specified layer.

2.0

Parameters

const TInt aLayer	Index of the layer, where 0 is the first one. The index must be less than aNumberOfLayers given to NewL().
const TRect & aRect	Rectangle where the image should be laid out.

Member Data Documentation

TAknsBackground * iLayoutArray

TAknsBackground *

iLayoutArray

[protected]

Array of layered layouts.

TInt iLayoutArraySize

TInt

iLayoutArraySize

[protected]

Size of the layer array.