Collapse all Symbian^3 Product Developer Library

MBitmapScalerPlugin Class Reference

class MBitmapScalerPlugin

Plugin API for the BitmapTransforms Library bitmap scaling. The CBitmapScaler implementation loads a plugin based on this interface class. Once this has been constructed, calls to method functions of CBitmapScaler are passed verbatim to this interface. For further description of required functionality, see CBitmapScaler.

CBitmapScaler

Public Member Functions
	~MBitmapScalerPlugin()
void	Cancel()
TInt	CustomCommand(TUid, TAny *)
void	Scale(TRequestStatus *, CFbsBitmap &, CFbsBitmap &, TBool)
void	Scale(TRequestStatus *, CFbsBitmap &, const TSize &, TBool)

Constructor & Destructor Documentation

~MBitmapScalerPlugin()

~MBitmapScalerPlugin

(

)

[inline, virtual]

This must provide an implementation as defined by CBitmapScaler::~CBitmapScaler()

CBitmapScaler::~CBitmapScaler()

Member Functions Documentation

Cancel()

void

Cancel

(

)

[pure virtual]

This must provide an implementation as defined by CBitmapScaler::Cancel()

CBitmapScaler::Cancel()

CustomCommand(TUid, TAny *)

TInt	CustomCommand	(	TUid	aUid,
			TAny *	aParam
		)	[pure virtual]

This must provide an implementation as defined by CBitmapScaler::CustomCommand(TUid aUid, TAny* aParam)

CBitmapScaler::CustomCommand(TUid aUid, TAny* aParam)

Parameters

TUid aUid
TAny * aParam

Scale(TRequestStatus *, CFbsBitmap &, CFbsBitmap &, TBool)

void	Scale	(	TRequestStatus *	aRequestStatus,
			CFbsBitmap &	aSrcBitmap,
			CFbsBitmap &	aTgtBitmap,
			TBool	aMaintainAspectRatio = ETrue
		)	[pure virtual]

This must provide an implementation as defined by CBitmapScaler::Scale(TRequestStatus* aRequestStatus, CFbsBitmap& aSrcBitmap, CFbsBitmap& aTgtBitmap, TBool aMaintainAspectRatio = ETrue)

CBitmapScaler::Scale(TRequestStatus* aRequestStatus, CFbsBitmap& aSrcBitmap, CFbsBitmap& aTgtBitmap, TBool aMaintainAspectRatio = ETrue)

Parameters

TRequestStatus * aRequestStatus	On return, contains a pointer to the completion status of the rescale of the bitmap.
CFbsBitmap & aSrcBitmap	The bitmap to be re-scaled.
CFbsBitmap & aTgtBitmap	The target location for the re-scaled bitmap.
TBool aMaintainAspectRatio = ETrue	A boolean indicating if the aspect ratio is maintained. ETrue means the aspect ratio is retained; this is the default. The same scaling factor is applied in both the horizontal and vertical directions. This is the smaller of the horizontal scaling factor and the vertical scaling factor. EFalse means the aspect ratio need not be retained.

Scale(TRequestStatus *, CFbsBitmap &, const TSize &, TBool)

void	Scale	(	TRequestStatus *	aRequestStatus,
			CFbsBitmap &	aBitmap,
			const TSize &	aDestinationSize,
			TBool	aMaintainAspectRatio = ETrue
		)	[pure virtual]

This must provide an implementation as defined by CBitmapScaler::Scale(TRequestStatus* aRequestStatus, CFbsBitmap& aBitmap, const TSize& aDestinationSize, TBool aMaintainAspectRatio = ETrue)

CBitmapScaler::Scale(TRequestStatus* aRequestStatus, CFbsBitmap& aBitmap, const TSize& aDestinationSize, TBool aMaintainAspectRatio = ETrue)

Parameters

TRequestStatus * aRequestStatus	On return, contains a pointer to the completion status of the rescale of the bitmap.
CFbsBitmap & aBitmap	The bitmap to be re-scaled. This reference is also the target location for the re-scaled bitmap.
const TSize & aDestinationSize	The requested target size for the re-scaled bitmap.
TBool aMaintainAspectRatio = ETrue	A boolean indicating if the aspect ratio is maintained. ETrue means the aspect ratio is retained; this is the default. The same scaling factor is applied in both the horizontal and vertical directions. This is the smaller of the horizontal scaling factor and the vertical scaling factor. EFalse means the aspect ratio need not be retained.