Class CMdaImageDataReadUtility

Interface status:

deprecated

class CMdaImageDataReadUtility : public CMdaImageUtility;

Description

Base class used in the derivation of CMdaImageDescToBitmapUtility and CMdaImageFileToBitmapUtility.

It has no user accessible functions.

Replaced by Image Conversion library - see CImageDecoder

Derivation

• MMdaObjectStateChangeObserver - ...

• CBase - Base class for all classes to be instantiated on the heap.

• CActive - The core class of the active object abstraction.

• CMdaImageUtility - Defines the public interface to image conversion.

• CMdaImageDataReadUtility - Base class used in the derivation of CMdaImageDescToBitmapUtility and CMdaImageF...

Members

Defined in CMdaImageDataReadUtility:

• CancelConvertL()Cancels the conversion operation.
• ConvertL(CFbsBitmap &,CFbsBitmap &,TInt)Begins the image conversion operation for the specified frame overloaded functio...
• ConvertL(CFbsBitmap &,TInt)Begins the image conversion operation for the specified frame overloaded functio...
• DoCancel()Implements cancellation of an outstanding request.
• DoClose()
• FrameCommentL(TInt)Returns a particular comment attached to a given frame of the image This functio...
• ImageReadUtil_Reserved2()
• ImageReadUtil_Reserved3()
• ImageReadUtil_Reserved4()
• RunL()Handles an active object's request completion event.
• ~CMdaImageDataReadUtility()Default destructor.

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• Extension_(TUint,TAny *&,TAny *)Extension function
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CMdaImageUtility:

• Close()Closes the open file-based or descriptor-based image.
• FrameCount()constReturns the number of frames in the image, counting from the first frame in the ...
• FrameInfo(TInt,TFrameInfo &)constRetrieves information about the specified frame.
• ImageUtil_Reserved1()
• ImageUtil_Reserved2()
• ImageUtil_Reserved3()
• ImageUtil_Reserved4()
• MoscoStateChangeEvent(CBase *,TInt,TInt,TInt)

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

virtual ~CMdaImageDataReadUtility();

Description

Default destructor.

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

IMPORT_C virtual void ConvertL(CFbsBitmap &aBitmap, TInt aFrameNumber=0);

Description

Begins the image conversion operation for the specified frame overloaded function.

The operation is asynchronous. When the conversion operation is complete, successfully or otherwise, the callback function MMdaImageUtilObserver::MiuoConvertComplete(TInt) is called.When converting from a file or descriptor to a bitmap, the operation can complete with KErrUnderflow, if there is insufficient information in the file or descriptor. Typically, this occurs when using the file or descriptor as a cache. In this situation, the conversion operation should be performed repeatedly until the file or descriptor has accumulated enough information for the operation to complete with KErrNone. As much of the image as is present is converted and written to the target bitmap at each call to this function.

Parameters

CFbsBitmap &aBitmap A reference to a bitmap. This may be a source or a target for the conversion process, depending on the concrete conversion class utility being used. TInt aFrameNumber The frame number. This value is relative to zero. For those concrete conversion classes which perform conversion from a bitmap, this value must always be zero. For those concrete conversion classes which perform conversion to a bitmap, this value must be less than the number of frames in the image.

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

IMPORT_C virtual void ConvertL(CFbsBitmap &aBitmap, CFbsBitmap &aMaskBitmap, TInt aFrameNumber=0);

Description

Begins the image conversion operation for the specified frame overloaded function.

The operation is asynchronous. When the conversion operation is complete, successfully or otherwise, the callback function MMdaImageUtilObserver::MiuoConvertComplete(TInt) is called.When converting from a file or descriptor to a bitmap, the operation can complete with KErrUnderflow, if there is insufficient information in the file or descriptor. Typically, this occurs when using the file or descriptor as a cache. In this situation, the conversion operation should be performed repeatedly until the file or descriptor has accumulated enough information for the operation to complete with KErrNone. As much of the image as is present is converted and written to the target bitmap at each call to this function.

Parameters

CFbsBitmap &aBitmap A reference to a bitmap. This may be a source or a target for the conversion process, depending on the concrete conversion class utility being used. CFbsBitmap &aMaskBitmap A source or target mask bitmap, if present. TInt aFrameNumber The frame number. This value is relative to zero. For those concrete conversion classes which perform conversion from a bitmap, this value must always be zero. For those concrete conversion classes which perform conversion to a bitmap, this value must be less than the number of frames in the image.

See also:

• CMdaImageUtility::ConvertL(CFbsBitmap &,TInt)Begins the image conversion operation for the specified frame overloaded functio...
• CFbsBitmapNote that this class is not intended for user derivation. A bitmap managed by th...

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

IMPORT_C virtual void CancelConvertL();

Description

Cancels the conversion operation.

The callback function MMdaImageUtilObserver::MiuoConvertComplete(TInt) is not called.

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

virtual void RunL();

Description

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's CMdaImageDataReadUtility::RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

CMdaImageDataReadUtility::RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls CActive::RunError(TInt) to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's CMdaImageDataReadUtility::RunL() or CActive::RunError(TInt) functions.

See also:

• CActiveScheduler::Start()Starts a new wait loop under the control of the current active scheduler.
• CActiveScheduler::Error(TInt)constHandles the result of a leave occurring in an active object’s RunL() function.
• CActiveScheduler::WaitForAnyRequest()Wait for an asynchronous request to complete.

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's CActive::Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

CMdaImageDataReadUtility::DoCancel() must not wait for event completion; this is handled by CActive::Cancel().

See also:

• CActive::Cancel()Cancels the wait for completion of an outstanding request.

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

IMPORT_C virtual const TDesC& FrameCommentL(TInt aFrameNumber);

Description

Returns a particular comment attached to a given frame of the image This function has been superceded by the parallel one in CImageDecoder, as this assumes that each frame has a comment within it, which is not always the case.

Parameters

TInt aFrameNumber The Frame Number within the image from which to retrieve the specified comment

Return value

const TDesC16 & The specified comment

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

virtual void ImageReadUtil_Reserved2();

Description

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

virtual void ImageReadUtil_Reserved3();

Description

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

virtual void ImageReadUtil_Reserved4();

Description

Interface status:

deprecated

Inherited from: CMdaImageDataReadUtility

protected: virtual void DoClose();

Description