CImageDisplayPlugin Class Reference

#include <icl/imagedisplayplugin.h>

Link against: imagedisplay.lib

class CImageDisplayPlugin : public CBase, public CBase

Inherits from

CImageDisplayPlugin
- CBase
- CBase

Protected Attributes
CImageDisplay::RImageSizeArray	iImageSizes

Public Member Enumerations
enum	TImageSourceType { EImgSrcNotDefined, EImgSrcFileName, EImgSrcFileHandle, EImgSrcDescriptor }
enum	TPluginStatus { EStatusNoMoreToDecode, EStatusBusy, EStatusPaused, EStatusFrameReady, ..., EStatusEraseOutputContents }

Public Member Functions
	~CImageDisplayPlugin()

Protected Member Functions
	CImageDisplayPlugin()
IMPORT_C void	AsyncCallbackImageReady(const CFbsBitmap *, TUint, const TRect &, TInt)
IMPORT_C TBool	CallbackIsRunning()
IMPORT_C void	CancelCallback()
IMPORT_C const TSize &	DestinationSizeInPixels()
IMPORT_C TDisplayMode	DisplayMode()
virtual IMPORT_C TInt	ExtensionInterface(TUid, TAny *&)
virtual IMPORT_C void	GetBitmap(const CFbsBitmap &, const CFbsBitmap &)
virtual IMPORT_C TUint	ImageStatus()
IMPORT_C TBool	MaintainAspectRatio()
virtual IMPORT_C TInt	NumFrames(TInt &)
pure virtual void	OpenL()
IMPORT_C TUint	Options()
pure virtual void	Pause()
pure virtual void	Play()
pure virtual const CImageDisplay::RImageSizeArray &	RecommendedImageSizes()
IMPORT_C const TDesC8 &	SourceData()
IMPORT_C const TDesC &	SourceDataId()
IMPORT_C ContentAccess::TIntent	SourceDataIntent()
IMPORT_C RFile &	SourceFileHandle()
IMPORT_C const TDesC &	SourceFilename()
IMPORT_C const TUid	SourceImageSubType()
IMPORT_C const TUid	SourceImageType()
IMPORT_C const TDesC8 &	SourceMimeType()
IMPORT_C TBool	SourceRect(TRect &)
IMPORT_C TImageSourceType	SourceType()
pure virtual void	StopPlay()
virtual IMPORT_C TBool	ValidBitmap()

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

Detailed Description

This is the plugin API for the Image Display framework Intended for use by plugin writers only.

Member Attribute Documentation

iImageSizes

CImageDisplay::RImageSizeArray

iImageSizes

[protected]

An array containing the sizes of the images.

Member Enumeration Documentation

Enum TImageSourceType

Data source type definitions for plug-ins

Enumerator	Value	Description
EImgSrcNotDefined	0	Undefined. Plug-in won't be given this value
EImgSrcFileName		The datasource is a file name
EImgSrcFileHandle		The datasource is a file handle
EImgSrcDescriptor		The datasource is a descriptor

Enum TPluginStatus

Defines an ImageDisplay plug-in status flag values

Enumerator	Value	Description
EStatusNoMoreToDecode	0x00000001	A plug-in has nothing more to decode; also must be set also on fatal error contidition
EStatusBusy	0x00000002	The next frame is not ready yet, bitmap may contain distorted image
EStatusPaused	0x00000004	Image decoding is paused i.e. call Play() to continue (if EStatusNoMoreToDecode is not set)
EStatusFrameReady	0x00000008	The next frame has been already decoded
EStatusDisplayThisFrameIndefinetely	0x00000010	May be set after image decode completion i.e. when EStatusNoMoreToDecode is set
EStatusPartialFrame	0x00000020	May be set if the image format supports progressive decoding; indicates that a bitmap contains roughtly decoded image
EStatusEraseOutputContents	0x00000040	May be set in case when a plug-in asks to invalidate previous frame contents

Constructor & Destructor Documentation

CImageDisplayPlugin ( )

IMPORT_C

CImageDisplayPlugin

(

)

[protected]

Exported default constructor

Constructor for the CImageDisplayPlugin class.

~CImageDisplayPlugin ( )

IMPORT_C

~CImageDisplayPlugin

(

)

Virtual destructor. Current implementation will call the REComSession::DestroyedImplementation() to finalize destruction of the ECom plugin

This is the destructor for the CImageDisplayPlugin and is responsible for deallocating all resources.

Member Function Documentation

AsyncCallbackImageReady ( const CFbsBitmap *, TUint, const TRect &, TInt )

IMPORT_C void	AsyncCallbackImageReady	(	const CFbsBitmap *	aBitmap,
			TUint	aStatus,
			const TRect &	aUpdatedArea,
			TInt	aError
		)	[protected]

A plug-in should use this function to pass information asinchronously to an API client. This function is asinchronous. Callback to the client application, via the ImageDisplay framework

Parameters
aBitmap	a pointer to the bitmap that contains decoding result
aStatus	the plugin status that should be combination of the TPluginStatus set
aUpdatedArea	a rectangle within the aBitmap that was updated during the latest operation
aError	error code of latest operation

CallbackIsRunning ( )

IMPORT_C TBool

CallbackIsRunning

(

)

const [protected]

A plug-in may use this function to determine if a previuos callback function to an API client has been completed

Return Value: ETrue if callback has not been completed yet

CancelCallback ( )

IMPORT_C void

CancelCallback

(

)

[protected]

A plug-in should use this function to cancel callback to a client if it is stil pending

DestinationSizeInPixels ( )

IMPORT_C const TSize &

DestinationSizeInPixels

(

)

const [protected]

returns a requested by an API client destination image size Gets the requested size of the destination image

Return Value: const TSize - requested image size in pixelsThe destination image size

DisplayMode ( )

IMPORT_C TDisplayMode

DisplayMode

(

)

const [protected]

returns a requested by an API client display mode for an image being decoded Return the display mode

Return Value: TDisplayMode - requested display modeDisplay mode of the image

ExtensionInterface ( TUid, TAny *& )

IMPORT_C TInt	ExtensionInterface	(	TUid	aIFaceUid,
			TAny *&	aIFacePtr
		)	[protected, virtual]

A plug-in that supports an extension interface has to override this function When a plugin extension has been implemented, this function should be implemented by the plugin writer to enable the client access to the extension

Parameters
aIFaceUid	a request extension Uid
aIFacePtr	a reference to the pointer that should be given extension interface pointer on success

Return Value: KErrNotSupported if requested extension is not supported otherwise KErrNoneA pointer to a fully constructed CImageDisplayPluginExtension NULL, if there is no extension to this plugin

GetBitmap ( const CFbsBitmap &, const CFbsBitmap & )

IMPORT_C void	GetBitmap	(	const CFbsBitmap *&	aBitmap,
			const CFbsBitmap *&	aMask
		)	const [protected, virtual]

A plug-in that supports image mask getting has to override this function

Parameters
aBitmap	a reference to bitmap pointer
aMask	a reference to bitmap pointer, a plug-in may return NULL if no mask is available

ImageStatus ( )

IMPORT_C TUint

ImageStatus

(

)

const [protected, virtual]

A plug-in that supports source image status checking has to override this function

Return Value: TUint - set of the TImageStatus flags

MaintainAspectRatio ( )

IMPORT_C TBool

MaintainAspectRatio

(

)

const [protected]

returns ETrue if an API client requested to preserve source image aspect ratio Return whether the client wishes to maintain the source image's aspect ratio

Return Value: TBool - requested aspect ratio flagETrue if the aspect ratio is to be maintained

NumFrames ( TInt & )

IMPORT_C TInt

NumFrames

(

TInt &

aNumFrames

)

const [protected, virtual]

A plug-in that supports getting of source image number of frames has to override this function

Parameters
aNumFrames	Number of frames in the source image

Return Value: TInt - KErrNone if aNumFrames contains a valid number of frames

OpenL ( )

void

OpenL

(

)

[protected, pure virtual]

Initialise the plugin and check the image display settings.

This is called by the ImageDisplay framework when the client app calls CImageDisplay::SetupL().

The plugin should check the validity of the source image and all other settings set by the client API. If any of these is unsupported then it should leave with KErrArgument

A plugin implementing CImageDisplayPluginExtension to allow extension of the client API should initialise it here.

This is a virtual function that each individual plugin must implement.

Leave Codes
KErrArgument	Some of the configuration parameters are invalid

Options ( )

IMPORT_C TUint

Options

(

)

const [protected]

returns a requested by an API client image options e.g. combination of the TImageOptions Gets the options requested by the client

Return Value: TUint - requested image option setThe options requested by the client

Pause ( )

void

Pause

(

)

[protected, pure virtual]

Pause image decoding

This is a virtual function that each individual plugin must implement.

Play ( )

void

Play

(

)

[protected, pure virtual]

Initiate the image display operation

This is a virtual function that each individual plugin must implement.

RecommendedImageSizes ( )

const CImageDisplay::RImageSizeArray &

RecommendedImageSizes

(

)

const [protected, pure virtual]

Should return an array of recommended image sizes i.e. sizes which would be processed faster This is a virtual function that each individual plugin must implement.

Return Value: a reference to the array of recommended image sizes

SourceData ( )

IMPORT_C const TDesC8 &

SourceData

(

)

const [protected]

returns an image source descriptor Gets the source descriptor

Return Value: const TDesC8& a reference to a 8 bit descriptor A reference to the source descriptor

Panic Codes
ImageDisplay	4 EImageWrongType if image data source is of type other than the descriptor
EImageWrongType	The source is not a descriptor

SourceDataId ( )

IMPORT_C const TDesC &

SourceDataId

(

)

const [protected]

returns requested content data Id that should be used to open content

Return Value: const TDesC& a desired data unique Id

SourceDataIntent ( )

IMPORT_C ContentAccess::TIntent

SourceDataIntent

(

)

const [protected]

returns an intent that is requested by client for opening the image source

Return Value: ContentAccess::TIntent a desired intent value

SourceFileHandle ( )

IMPORT_C RFile &

SourceFileHandle

(

)

const [protected]

returns an image source file handle Gets the source file name

Return Value: const RFile& a reference to a file handle The source file handle

Panic Codes
ImageDisplay	4 EImageWrongType if image data source is of type other than the file handle
EImageWrongType	The source is not a file

SourceFilename ( )

IMPORT_C const TDesC &

SourceFilename

(

)

const [protected]

returns an image source file name Gets the source file name

Return Value: const TDesC& a reference to read-only descriptor The source file name

Panic Codes
ImageDisplay	4 EImageWrongType if image data source is of type other than the file name
EImageWrongType	The source is not a file

SourceImageSubType ( )

IMPORT_C const TUid

SourceImageSubType

(

)

const [protected]

returns a global image subtype or KNullUid if not defined Gets the source image's subtype

Return Value: const TUid an image subtype UidThe UID of the source type KNullUid if not defined

SourceImageType ( )

IMPORT_C const TUid

SourceImageType

(

)

const [protected]

returns a global image type Gets the source image's type

Return Value: const TUid an image type UidThe UID of the source type KNullUid if not defined

SourceMimeType ( )

IMPORT_C const TDesC8 &

SourceMimeType

(

)

const [protected]

returns an image source MIME type or KNullDesC8 if not defined Gets the source image's MIME type

Return Value: const TDesC8& a reference to a 8 bit descriptorA reference to the source image's MIME type KNullDesC8 if not defined

SourceRect ( TRect & )

IMPORT_C TBool

SourceRect

(

TRect &

aRect

)

const [protected]

returns a requested by an API client source clipping rect Gets the source image's clipping region

Parameters
aRect	The source image's clipping region

Return Value: ETrue if clipping rect was defined by clientETrue if a clipping region has been defined

SourceType ( )

IMPORT_C TImageSourceType

SourceType

(

)

const [protected]

returns an image datasource type Return whether the source is data

Return Value: TImageSourceTypeTImageSourceType the source of image

StopPlay ( )

void

StopPlay

(

)

[protected, pure virtual]

Cancel the image display operation May be called by the framework even when there is no outstanding request.

This is a virtual function that each individual plugin must implement.

ValidBitmap ( )

IMPORT_C TBool

ValidBitmap

(

)

const [protected, virtual]

A plug-in that supports target bitmap status checkig has to override this function

Return Value: TBool - ETrue if subsequent call to the GetBitmap() able to return valid bitmaps

CImageDisplayPlugin Class Reference

Inherits from

Detailed Description

Member Attribute Documentation

iImageSizes

Member Enumeration Documentation

Enum TImageSourceType

Enum TPluginStatus

Constructor & Destructor Documentation

CImageDisplayPlugin ( )

~CImageDisplayPlugin ( )

Member Function Documentation

AsyncCallbackImageReady ( const CFbsBitmap *, TUint, const TRect &, TInt )

CallbackIsRunning ( )

CancelCallback ( )

DestinationSizeInPixels ( )

DisplayMode ( )

ExtensionInterface ( TUid, TAny *& )

GetBitmap ( const CFbsBitmap *&, const CFbsBitmap *& )

ImageStatus ( )

MaintainAspectRatio ( )

NumFrames ( TInt & )

OpenL ( )

Options ( )

Pause ( )

Play ( )

RecommendedImageSizes ( )

SourceData ( )

SourceDataId ( )

SourceDataIntent ( )

SourceFileHandle ( )

SourceFilename ( )

SourceImageSubType ( )

SourceImageType ( )

SourceMimeType ( )

SourceRect ( TRect & )

SourceType ( )

StopPlay ( )

ValidBitmap ( )

GetBitmap ( const CFbsBitmap &, const CFbsBitmap & )