![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
|
|
|
|
|
|
||
class CImageTransformPlugin : public CBase;
This is the plugin API for the Image Transform framework Intended for use by plugin writers only.
CBase -
Base class for all classes to be instantiated on the heap.
CImageTransformPlugin - This is the plugin API for the Image Transform framework Intended for use by plu...
Defined in CImageTransformPlugin:
CImageTransformPlugin()Constructor for this class. CancelTransform()Cancel the image transform operation May be called by the framework even when th...DestData()constGets the destination descriptorDestFilename()constGets the destination file nameDestIsData()constReturn whether the destination image is to be stored as dataDestIsFilename()constReturn whether the destination image is to be stored in a fileDestinationSizeInPixels()constGets the requested size of the destination imageExtension()constWhen a plugin extension has been implemented, this function should be implemente...MaintainAspectRatio()constReturn whether the client wishes to maintain the source image's aspect ratioOpenL()Initialise the plugin and check the image transform settings.Options()constGets the options requested by the clientPreserveImageData()constReturn whether the client wishes to attempt to maintain the original image dataReservedVirtual1()Reserved for future-proofing ReservedVirtual2()Reserved for future-proofing ReservedVirtual3()Reserved for future-proofing ReservedVirtual4()Reserved for future-proofing SourceData()constGets the source descriptorSourceFilename()constGets the source file nameSourceImageSubType()constGets the source image's subtypeSourceImageType()constGets the source image's typeSourceIsData()constReturn whether the source is dataSourceIsFilename()constReturn whether the source is a fileSourceMimeType()constGets the source image's MIME typeSourceRect(TRect &)constGets the source image's clipping regionTransform(TRequestStatus &)Initiate the image transform operation~CImageTransformPlugin()This is the destructor for the CImageTransformPlugin and is responsible for deal...Inherited from CBase:
Delete(CBase *)Deletes the specified object.Extension_(TUint,TAny *&,TAny *)Extension function 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...IMPORT_C ~CImageTransformPlugin();
This is the destructor for the CImageTransformPlugin and is responsible for deallocating all resources.
|
|
protected: virtual void OpenL()=0;
Initialise the plugin and check the image transform settings.
This is called by the ImageTransform framework when the client app calls CImageTransform::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 KErrNotSupported.
A plugin implementing CImageTransformPluginExtension to allow extension of the client API should initialise it here.
This is a virtual function that each individual plugin must implement.
|
protected: virtual void Transform(TRequestStatus &aStatus)=0;
Initiate the image transform operation
This is a virtual function that each individual plugin must implement.
|
protected: virtual void CancelTransform()=0;
Cancel the image transform 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.
protected: IMPORT_C TBool SourceIsFilename() const;
Return whether the source is a file
|
protected: IMPORT_C TBool SourceIsData() const;
Return whether the source is data
|
protected: IMPORT_C const TDesC& SourceFilename() const;
Gets the source file name
|
|
protected: IMPORT_C const TDesC8& SourceData() const;
Gets the source descriptor
|
|
protected: IMPORT_C const TDesC8& SourceMimeType() const;
Gets the source image's MIME type
|
protected: IMPORT_C const TUid SourceImageType() const;
Gets the source image's type
|
protected: IMPORT_C const TUid SourceImageSubType() const;
Gets the source image's subtype
|
protected: IMPORT_C TBool SourceRect(TRect &aRect) const;
Gets the source image's clipping region
|
|
protected: IMPORT_C TBool DestIsFilename() const;
Return whether the destination image is to be stored in a file
|
protected: IMPORT_C TBool DestIsData() const;
Return whether the destination image is to be stored as data
|
protected: IMPORT_C const TDesC& DestFilename() const;
Gets the destination file name
|
|
protected: IMPORT_C HBufC8 *& DestData() const;
Gets the destination descriptor
|
|
protected: IMPORT_C const TSize& DestinationSizeInPixels() const;
Gets the requested size of the destination image
|
protected: IMPORT_C TUint Options() const;
Gets the options requested by the client
|
protected: IMPORT_C TBool MaintainAspectRatio() const;
Return whether the client wishes to maintain the source image's aspect ratio
|
protected: IMPORT_C TBool PreserveImageData() const;
Return whether the client wishes to attempt to maintain the original image data
|
protected: IMPORT_C virtual CImageTransformPluginExtension* Extension() const;
When a plugin extension has been implemented, this function should be implemented by the plugin writer to enable the client access to the extension
|
private: IMPORT_C virtual void ReservedVirtual4();
Reserved for future-proofing
|
Copyright © 2005-2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)