CAknsLayeredBackgroundControlContext Class Reference

API published in: S60 2nd Ed

Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib

Capability Information

Required Capabilities

None

#include <aknslayeredbackgroundcontrolcontext.h>

Inherits CAknsBasicBackgroundControlContext.

Inherited by CAknsFrameBackgroundControlContext.

Detailed Description

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.

Public Member Functions

virtual ~CAknsLayeredBackgroundControlContext ()

Destructor.

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

Sets the item ID of the specified layer.

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

Sets the layout rectangle of the specified layer.

TBool IsCompatibleWithType (const TAknsControlContextType aType) const

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

Parameters:

aType

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

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

Static Public Member Functions

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

Two-phased constructor.

Protected Member Functions

CAknsLayeredBackgroundControlContext ()

C++ constructor.

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

Symbian 2nd phase constructor.

Protected Attributes

TAknsBackground * iLayoutArray

Array of layered layouts.

TInt iLayoutArraySize

Size of the layer array.

Constructor & Destructor Documentation

virtual CAknsLayeredBackgroundControlContext::~CAknsLayeredBackgroundControlContext ( ) [virtual]

Destructor.

CAknsLayeredBackgroundControlContext::CAknsLayeredBackgroundControlContext ( ) [protected]

C++ constructor.

Member Function Documentation

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

Symbian 2nd phase constructor.

TBool CAknsLayeredBackgroundControlContext::IsCompatibleWithType ( const TAknsControlContextType aType ) const [virtual]

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

Parameters:

aType

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

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

Reimplemented from CAknsBasicBackgroundControlContext.

Reimplemented in CAknsFrameBackgroundControlContext.

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

Two-phased constructor.

Parameters:

	aImageID	Item ID of the first background bitmap.
	aRect	Rectangle where the first bitmap should be laid out.
	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.
	aNumberOfLayers	Total number of layers as an integer. This must be 1 or more.

Returns:: Newly constructed object.

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

Sets the item ID of the specified layer.

Parameters:

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

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

Sets the layout rectangle of the specified layer.

Parameters:

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

Field Documentation

TAknsBackground* CAknsLayeredBackgroundControlContext::iLayoutArray [protected]

Array of layered layouts.

TInt CAknsLayeredBackgroundControlContext::iLayoutArraySize [protected]

Size of the layer array.

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

aknslayeredbackgroundcontrolcontext.h