CAknsListBoxBackgroundControlContext Class Reference

class CAknsListBoxBackgroundControlContext : public CAknsBasicBackgroundControlContext

Implementation of a control context that provides a layout background with a background bitmap, its layout rectangle, a secondary bitmap that will be tiled in its own layout rectangle and third bitmap for the bottom part with 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

CAknsListBoxBackgroundControlContext
- CAknsBasicBackgroundControlContext
  - CBase

Public Member Functions
	~CAknsListBoxBackgroundControlContext()
TBool	IsCompatibleWithType(const TAknsControlContextType)
IMPORT_C CAknsListBoxBackgroundControlContext *	NewL(const TAknsItemID &, const TRect &, const TBool, const TAknsItemID &, const TRect &)
IMPORT_C void	SetBottomBitmap(const TAknsItemID &)
IMPORT_C void	SetBottomRect(const TRect &)
IMPORT_C void	SetTiledBitmap(const TAknsItemID &)
IMPORT_C void	SetTiledRect(const TRect &)
TInt	UpdateContext()

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

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 *	iBottomLayout
TAknsBackground *	iTiledLayout

Inherited Attributes
	CAknsBasicBackgroundControlContext::iLayout
	CAknsBasicBackgroundControlContext::iParentContext

Constructor & Destructor Documentation

CAknsListBoxBackgroundControlContext()

CAknsListBoxBackgroundControlContext

(

)

[protected]

C++ constructor.

~CAknsListBoxBackgroundControlContext()

~CAknsListBoxBackgroundControlContext

(

)

[virtual]

Destructor.

Member Functions Documentation

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

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

Symbian 2nd phase constructor.

Parameters

const TRect & aRect
const TBool aParentAbsolute
const TAknsItemID & aImageID
const TAknsItemID & aTiledBitmapID
const TRect & aTiledRect

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 TAknsItemID &, const TRect &)

IMPORT_C CAknsListBoxBackgroundControlContext *	NewL	(	const TAknsItemID &	aImageID,
			const TRect &	aRect,
			const TBool	aParentAbsolute,
			const TAknsItemID &	aTiledBitmapID,
			const TRect &	aTiledRect
		)	[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.
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 TAknsItemID & aTiledBitmapID	Item ID of the second bitmap that will be tiled in another layout rectangle.
const TRect & aTiledRect	Rectangle where the second bitmap should be tiled to.

SetBottomBitmap(const TAknsItemID &)

IMPORT_C void

SetBottomBitmap

(

const TAknsItemID &

aID

)

Sets the item ID of the bottom part bitmap.

2.0

Parameters

const TAknsItemID & aID

Item ID of the bitmap.

SetBottomRect(const TRect &)

IMPORT_C void

SetBottomRect

(

const TRect &

aRect

)

Sets the layout rectangle of the bottom part bitmap.

2.0

Parameters

const TRect & aRect

Rectangle where the bitmap should be laid out.

SetTiledBitmap(const TAknsItemID &)

IMPORT_C void

SetTiledBitmap

(

const TAknsItemID &

aID

)

Sets the item ID of the tiled bitmap.

2.0

Parameters

const TAknsItemID & aID

Item ID of the bitmap.

SetTiledRect(const TRect &)

IMPORT_C void

SetTiledRect

(

const TRect &

aRect

)

Sets the layout rectangle of the tiled bitmap.

2.0

Parameters

const TRect & aRect

Rectangle where the bitmap should be laid out.

UpdateContext()

TInt

UpdateContext

(

)

Updates the control context, if necessary. This method is called by the framework before drawing with the context.

Implementation in CAknsListBoxBackgroundControlContext disables any non-existing levels.

2.8

Return value reserved for future use. Currently returns 0.

Member Data Documentation

TAknsBackground * iBottomLayout

TAknsBackground *

iBottomLayout

[protected]

Structure for bottom part layout.

TAknsBackground * iTiledLayout

TAknsBackground *

iTiledLayout

[protected]

Structure for tiled layout.