Collapse all Symbian^3 Application Developer Library

CPbkThumbnailManager Class Reference

class CPbkThumbnailManager : public CBase

Phonebook thumbnail manager. Contains operations for attaching, removing and querying thumbnail images connected to Phonebook contacts.

All the Set* operations convert the image to full color (24 bits/pixel) JPEG format and scale it to KPbkPersonalImageSize before connecting the image to a contact. Scaling does not change image's aspect ratio. If the original image is in JPEG format and its size is <=KPbkPersonalImageSize a copy of the original image is stored directly.

MPbkThumbnailOperation MPbkThumbnailGetObserver MPbkThumbnailSetObserver

Inherits from

CPbkThumbnailManager
- CBase

Public Member Functions
	~CPbkThumbnailManager ()
IMPORT_C MPbkThumbnailOperation *	GetThumbnailAsyncL ( MPbkThumbnailGetObserver &, const CPbkContactItem &)
IMPORT_C MPbkThumbnailOperation *	GetThumbnailAsyncL ( MPbkThumbnailGetObserver &, const CPbkContactItem &, TPbkImageLoadParameters &)
IMPORT_C MPbkThumbnailOperation *	GetThumbnailImageAsyncL ( MPbkThumbnailGetImageObserver &, const CPbkContactItem &)
IMPORT_C TBool	HasThumbnail (const CPbkContactItem &)
IMPORT_C CPbkThumbnailManager *	NewL ( CPbkContactEngine &)
IMPORT_C void	RemoveThumbnail ( CPbkContactItem &)
IMPORT_C MPbkThumbnailOperation *	SetThumbnailAsyncL ( MPbkThumbnailSetObserver &, CPbkContactItem &, const CFbsBitmap &)
IMPORT_C MPbkThumbnailOperation *	SetThumbnailAsyncL ( MPbkThumbnailSetObserver &, CPbkContactItem &, const TDesC8 &)
IMPORT_C MPbkThumbnailOperation *	SetThumbnailAsyncL ( MPbkThumbnailSetObserver &, CPbkContactItem &, const TDesC &)

Private Member Functions
	CPbkThumbnailManager ( CPbkContactEngine &)
void	ConstructL ()

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
CPbkContactEngine &	iEngine

Constructor & Destructor Documentation

CPbkThumbnailManager(CPbkContactEngine &)

CPbkThumbnailManager

(

CPbkContactEngine &

aEngine

)

[private]

Parameters

CPbkContactEngine & aEngine

~CPbkThumbnailManager()

~CPbkThumbnailManager

(

)

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

GetThumbnailAsyncL(MPbkThumbnailGetObserver &, const CPbkContactItem &)

IMPORT_C MPbkThumbnailOperation *	GetThumbnailAsyncL	(	MPbkThumbnailGetObserver &	aObserver,
			const CPbkContactItem &	aContactItem
		)

Gets a thumbnail bitmap from a contact asynchronously.

Parameters

MPbkThumbnailGetObserver & aObserver	Observer for this operation.
const CPbkContactItem & aContactItem	Contact to retrieve the thumbnail from.

GetThumbnailAsyncL(MPbkThumbnailGetObserver &, const CPbkContactItem &, TPbkImageLoadParameters &)

IMPORT_C MPbkThumbnailOperation *	GetThumbnailAsyncL	(	MPbkThumbnailGetObserver &	aObserver,
			const CPbkContactItem &	aContactItem,
			TPbkImageLoadParameters &	aParams
		)

Gets a parameterized thumbnail bitmap from a contact asynchronously.

TPbkImageLoadParameters

Parameters

MPbkThumbnailGetObserver & aObserver	Observer for this operation.
const CPbkContactItem & aContactItem	Contact to retrieve the thumbnail from.
TPbkImageLoadParameters & aParams	Parameters for bitmap, see TPbkImageLoadParameters. NOTE: iFrameNumber parameter has no meaning.

GetThumbnailImageAsyncL(MPbkThumbnailGetImageObserver &, const CPbkContactItem &)

IMPORT_C MPbkThumbnailOperation *	GetThumbnailImageAsyncL	(	MPbkThumbnailGetImageObserver &	aObserver,
			const CPbkContactItem &	aContactItem
		)

Gets a thumbnail image from a contact asynchronously.

Parameters

MPbkThumbnailGetImageObserver & aObserver	Observer for this operation.
const CPbkContactItem & aContactItem	Contact to retrieve the thumbnail from.

HasThumbnail(const CPbkContactItem &)

IMPORT_C TBool

HasThumbnail

(

const CPbkContactItem &

aContactItem

)

const

Returns true if aContactItem has a thumbnail image attached to it.

Parameters

const CPbkContactItem & aContactItem

Contact that is queried for thumbnail.

NewL(CPbkContactEngine &)

IMPORT_C CPbkThumbnailManager *

NewL

(

CPbkContactEngine &

aEngine

)

[static]

Creates and returns a new thumbnail manager.

Parameters

CPbkContactEngine & aEngine

Phonebook contact engine

RemoveThumbnail(CPbkContactItem &)

IMPORT_C void

RemoveThumbnail

(

CPbkContactItem &

aContactItem

)

Removes any thumbnail image from aContactItem.

Parameters

CPbkContactItem & aContactItem

Contact whose thumbnail is removed.

SetThumbnailAsyncL(MPbkThumbnailSetObserver &, CPbkContactItem &, const CFbsBitmap &)

IMPORT_C MPbkThumbnailOperation *	SetThumbnailAsyncL	(	MPbkThumbnailSetObserver &	aObserver,
			CPbkContactItem &	aContactItem,
			const CFbsBitmap &	aBitmap
		)

Sets a thumbnail image for a contact asynchronously.

Parameters

MPbkThumbnailSetObserver & aObserver	Observer for this operation.
CPbkContactItem & aContactItem	Contact to set the thumbnail to.
const CFbsBitmap & aBitmap	Bitmap to set as the thumbnail for aContact.

SetThumbnailAsyncL(MPbkThumbnailSetObserver &, CPbkContactItem &, const TDesC8 &)

IMPORT_C MPbkThumbnailOperation *	SetThumbnailAsyncL	(	MPbkThumbnailSetObserver &	aObserver,
			CPbkContactItem &	aContactItem,
			const TDesC8 &	aImageBuffer
		)

Sets a thumbnail image for a contact asynchronously.

Parameters

MPbkThumbnailSetObserver & aObserver	Observer for this operation.
CPbkContactItem & aContactItem	Contact to set the thumbnail to.
const TDesC8 & aImageBuffer	Image buffer to set as the thumbnail for aContact.

SetThumbnailAsyncL(MPbkThumbnailSetObserver &, CPbkContactItem &, const TDesC &)

IMPORT_C MPbkThumbnailOperation *	SetThumbnailAsyncL	(	MPbkThumbnailSetObserver &	aObserver,
			CPbkContactItem &	aContactItem,
			const TDesC &	aFileName
		)

Sets a thumbnail image for a contact asynchronously.

Parameters

MPbkThumbnailSetObserver & aObserver	Observer for this operation.
CPbkContactItem & aContactItem	Contact to set the thumbnail to.
const TDesC & aFileName	File name for a image to set as the thumbnail for aContact.

Member Data Documentation

CPbkContactEngine & iEngine

CPbkContactEngine &

iEngine

[private]