CAknsBasicBackgroundControlContext Class Reference

class CAknsBasicBackgroundControlContext : public CBase

Implementation of a control context that provides a layout background with a background bitmap and its layout rectangle.

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

AknSkins.lib

2.0

Inherits from

CAknsBasicBackgroundControlContext
- CBase

Public Member Functions
	~CAknsBasicBackgroundControlContext()
TBool	IsCompatibleWithType(const TAknsControlContextType)
IMPORT_C CAknsBasicBackgroundControlContext *	NewL(const TAknsItemID &, const TRect &, TBool)
IMPORT_C void	SetBitmap(const TAknsItemID &)
IMPORT_C void	SetParentContext(MAknsControlContext *)
IMPORT_C void	SetParentPos(const TPoint &)
IMPORT_C void	SetRect(const TRect &)
TAny *	SupplySkinObject(TAknsCCObject)
TInt	SupplySkinParameter(TAknsCCParameter)

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

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

Protected Attributes
TAknsBackground *	iLayout
MAknsControlContext *	iParentContext

Constructor & Destructor Documentation

CAknsBasicBackgroundControlContext()

CAknsBasicBackgroundControlContext

(

)

[protected]

C++ constructor.

~CAknsBasicBackgroundControlContext()

~CAknsBasicBackgroundControlContext

(

)

[virtual]

Destructor.

Member Functions Documentation

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

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

Symbian 2nd phase constructor.

Parameters

const TRect & aRect
TBool aParentAbsolute
const TAknsItemID & aImageID

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 &, TBool)

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

Two-phased constructor.

2.0

Newly constructed object.

Parameters

const TAknsItemID & aImageID	Item ID of the background bitmap.
const TRect & aRect	Rectangle where the bitmap should be laid out.
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.

SetBitmap(const TAknsItemID &)

IMPORT_C void

SetBitmap

(

const TAknsItemID &

aID

)

Sets the item ID of the background bitmap.

2.0

Parameters

const TAknsItemID & aID

Item ID of the bitmap.

SetParentContext(MAknsControlContext *)

IMPORT_C void

SetParentContext

(

MAknsControlContext *

aParentContext

)

Sets the parent context (drawn beneath the context itself). No ownership is claimed. The parent context object must be valid as long as it is set as parent context.

2.6

Parameters

MAknsControlContext * aParentContext

Pointer to the parent context, or NULL (default value) if none used.

SetParentPos(const TPoint &)

IMPORT_C void

SetParentPos

(

const TPoint &

aPos

)

Sets the parent position for the layout. This is only used if parent absolute layout was enabled during construction.

2.0

Parameters

const TPoint & aPos

Parent position in screen relative coordinates.

SetRect(const TRect &)

IMPORT_C void

SetRect

(

const TRect &

aRect

)

Sets the layout rectangle of the bitmap.

2.0

Parameters

const TRect & aRect

Rectangle where the bitmap should be laid out.

SupplySkinObject(TAknsCCObject)

TAny *

SupplySkinObject

(

TAknsCCObject

aObject

)

Provides context specific object.

2.0

Pointer to object as defined in TAknsCCObject for that specific aObject parameter value. For unknown or unhandled values NULL must be returned.

Parameters

TAknsCCObject aObject

Type of the object to be retrieved. Possible values are defined in TAknsCCObject enumeration.

SupplySkinParameter(TAknsCCParameter)

TInt

SupplySkinParameter

(

TAknsCCParameter

aParam

)

Provides context specific integer parameter.

2.0

Integer value as defined in TAknsCCParameter for the particular parameter. For unknown or unhandled values zero must be returned.

Parameters

TAknsCCParameter aParam

Type of the parameter to be retrieved. Possible values are defined in TAknsCCParameter enumeration.

Member Data Documentation

TAknsBackground * iLayout

TAknsBackground *

iLayout

[protected]

MAknsControlContext * iParentContext

MAknsControlContext *

iParentContext

[protected]