COverlayTransformExtension Class Reference

#include <icl/overlaytransformextension.h>

class COverlayTransformExtension : public CImageTransformPluginExtension, public CImageTransformPluginExtension

Inherits from

COverlayTransformExtension
- CImageTransformPluginExtension
  - CBase
  - CBase
- CImageTransformPluginExtension
  - CBase
  - CBase

Public Member Functions
IMPORT_C void	SetOverlayDataL(const TDesC8 &, const TUid &)
IMPORT_C void	SetOverlayFileL(const TDesC &, const TUid &)
IMPORT_C void	SetOverlayImageL(const CFbsBitmap &)
IMPORT_C void	SetOverlayImageL(const CImageFrame &)
IMPORT_C void	SetPosition(const TPoint &)
IMPORT_C void	SetTransparencyLevelL(TUint)
IMPORT_C void	SupportedOverlayInputFormatsL(RArray< TUid > &)
IMPORT_C void	SupportedOverlayInputSubFormatsL(TUid, RArray< TUid > &)

Protected Member Functions
pure virtual void	DoSetOverlayDataL(const TDesC8 &, const TUid &)
pure virtual void	DoSetOverlayFileL(const TDesC &, const TUid &)
pure virtual void	DoSetOverlayImageL(const CFbsBitmap &)
pure virtual void	DoSetOverlayImageL(const CImageFrame &)
pure virtual void	DoSetPosition(const TPoint &)
pure virtual void	DoSetTransparencyLevelL(TUint)
pure virtual void	DoSupportedOverlayInputFormatsL(RArray< TUid > &)
pure virtual void	DoSupportedOverlayInputSubFormatsL(TUid, RArray< TUid > &)

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()
	CImageTransformPluginExtension::Uid()const

Detailed Description

Overlay/Replace Extension to the ImageTransform plugin

The class provides the methods to set the overlay/replace parameters and is intended to be implemented by the plugins supporting the blending of the images. The client can set the overlay image, the overlay position and the transparency of the overlay image. The plugin supporting this extension must use the opaque_data v2 format in RSS file and also the overlay flag must be set in the opaque_data. The client must retrieve this extension implementation from the plugin using its extension UID.

Member Function Documentation

DoSetOverlayDataL ( const TDesC8 &, const TUid & )

void	DoSetOverlayDataL	(	const TDesC8 &	aData,
			const TUid &	aOverlayImageUid
		)	[protected, pure virtual]

DoSetOverlayFileL ( const TDesC &, const TUid & )

void	DoSetOverlayFileL	(	const TDesC &	aFilename,
			const TUid &	aOverlayImageUid
		)	[protected, pure virtual]

DoSetOverlayImageL ( const CFbsBitmap & )

void

DoSetOverlayImageL

(

const CFbsBitmap &

aBitmap

)

[protected, pure virtual]

DoSetOverlayImageL ( const CImageFrame & )

void

DoSetOverlayImageL

(

const CImageFrame &

aImageFrame

)

[protected, pure virtual]

DoSetPosition ( const TPoint & )

void

DoSetPosition

(

const TPoint &

aPosition

)

[protected, pure virtual]

DoSetTransparencyLevelL ( TUint )

void

DoSetTransparencyLevelL

(

TUint

aLevel

)

[protected, pure virtual]

DoSupportedOverlayInputFormatsL ( RArray< TUid > & )

void

DoSupportedOverlayInputFormatsL

(

RArray< TUid > &

aFormats

)

const [protected, pure virtual]

DoSupportedOverlayInputSubFormatsL ( TUid, RArray< TUid > & )

void	DoSupportedOverlayInputSubFormatsL	(	TUid	aFormat,
			RArray< TUid > &	aSubFormats
		)	const [protected, pure virtual]

SetOverlayDataL ( const TDesC8 &, const TUid & )

IMPORT_C void	SetOverlayDataL	(	const TDesC8 &	aData,
			const TUid &	aOverlayImageUid
		)

Sets the Overlay image in the descriptor

Parameters
aData	The descriptor containing overlay image
aOverlayImageUid	The format of the overlay image

Leave Codes
KErrNotSupported	The plugin does not support this format of the the overlay image file

SetOverlayFileL ( const TDesC &, const TUid & )

IMPORT_C void	SetOverlayFileL	(	const TDesC &	aFilename,
			const TUid &	aOverlayImageUid
		)

Sets the Overlay image in the file

Parameters
aFilename	The overlay image filename
aOverlayImageUid	The format of the overlay image

Leave Codes
KErrNotSupported	The plugin does not support this format of the the overlay image file

SetOverlayImageL ( const CFbsBitmap & )

IMPORT_C void

SetOverlayImageL

(

const CFbsBitmap &

aBitmap

)

Sets the Overlay image in the bitmap

Parameters
aBitmap	The bitmap containing overlay image

Leave Codes
KErrNotSupported	The plugin does not support this format of the the overlay image file

SetOverlayImageL ( const CImageFrame & )

IMPORT_C void

SetOverlayImageL

(

const CImageFrame &

aImageFrame

)

Sets the Overlay image in the image frame

Parameters
aImageFrame	The image frame containing the overlay image

Leave Codes
KErrNotSupported	The plugin does not support this format of the the overlay image file

SetPosition ( const TPoint & )

IMPORT_C void

SetPosition

(

const TPoint &

aPosition

)

This function sets the position, where overlay image is to be placed

Parameters
aPosition	The position for overlay image

SetTransparencyLevelL ( TUint )

IMPORT_C void

SetTransparencyLevelL

(

TUint

aLevel

)

Sets the transparency level of the overlay image. Its value can be 0-100 where 0 for no transparency and 100 for fully transparent. If overlay image is CFbsBitmap/CImageFrame then it can have alpha value. In this case when the application sets the transparency level using this function then the alpha value must be ignored.

Parameters
aLevel	The transparency level

Leave Codes
KErrNotSupported	The plugin does not support this.

SupportedOverlayInputFormatsL ( RArray< TUid > & )

IMPORT_C void

SupportedOverlayInputFormatsL

(

RArray< TUid > &

aFormats

)

const

Gets the formats of the overlay image that are supported

Parameters
aFormats	On return, contains the supported overlay image formats

Leave Codes
The	function leaves with one of the system wide error codes, if the operation fails

SupportedOverlayInputSubFormatsL ( TUid, RArray< TUid > & )

IMPORT_C void	SupportedOverlayInputSubFormatsL	(	TUid	aFormat,
			RArray< TUid > &	aSubFormats
		)	const

Gets the sub-formats of Overlay image that are supported

Parameters
aFormat	The image format for which supported sub-format list is required
aSubFormats	On return, contains the supported overlay image sub-formats

Leave Codes
The	function leaves with one of the system wide error codes, if the operation fails