williamr@2: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: // This is the plugin API for the Image Transform framework
williamr@2: // 
williamr@2: //
williamr@2: /**
williamr@2:  @file
williamr@2:  @publishedAll
williamr@2:  @released
williamr@2: */
williamr@2: 
williamr@2: #ifndef __IMAGETRANSFORMPLUGIN_H__
williamr@2: #define __IMAGETRANSFORMPLUGIN_H__
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <imagetransform.h>
williamr@2: 
williamr@2: // fwd ref
williamr@2: class CImageTransformFramework;
williamr@2: class CImageTransformPluginExtension;
williamr@2: 
williamr@2: /**
williamr@2: This is the plugin API for the Image Transform framework
williamr@2: Intended for use by plugin writers only.
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: class CImageTransformPlugin : public CBase
williamr@2: 	{
williamr@2: 	friend class CImageTransformFramework;
williamr@2: 
williamr@2: public:
williamr@2: 	IMPORT_C ~CImageTransformPlugin();
williamr@2: 
williamr@2: protected:
williamr@2: 	/**
williamr@2: 	Initialise the plugin and check the image transform settings.
williamr@2: 
williamr@2: 	This is called by the ImageTransform framework when the client app calls
williamr@2: 	CImageTransform::SetupL(). 
williamr@2: 	
williamr@2: 	The plugin should check the validity of the source image and all other settings
williamr@2: 	set by the client API. If any of these is unsupported then it should leave with 
williamr@2: 	KErrNotSupported.
williamr@2: 
williamr@2: 	A plugin implementing CImageTransformPluginExtension to allow extension of the 
williamr@2: 	client API should initialise it here.
williamr@2: 
williamr@2: 	This is a virtual function that each individual plugin must implement.
williamr@2: 
williamr@2: 	@leave  KErrUnsupported
williamr@2: 	The plugin decoder doesn not support the request transformation
williamr@2: 	*/
williamr@2: 	virtual void OpenL() = 0;
williamr@2: 
williamr@2: 	/**
williamr@2: 	Initiate the image transform operation
williamr@2: 
williamr@2: 	This is a virtual function that each individual plugin must implement.
williamr@2: 
williamr@2: 	@param  aStatus
williamr@2: 			The client's request status. 
williamr@2: 			On completion contains an error code.
williamr@2: 			KErrNone if image was transformed successfully,
williamr@2: 	*/
williamr@2: 	virtual void Transform(TRequestStatus& aStatus) = 0;
williamr@2: 
williamr@2: 	/**
williamr@2: 	Cancel the image transform operation
williamr@2: 	May be called by the framework even when there is no outstanding request.
williamr@2: 
williamr@2: 	This is a virtual function that each individual plugin must implement.
williamr@2: 	*/
williamr@2: 	virtual void CancelTransform() = 0;
williamr@2: 
williamr@2: 	IMPORT_C CImageTransformPlugin();
williamr@2: 
williamr@2: 	// getters
williamr@2: 	IMPORT_C TBool SourceIsFilename() const;
williamr@2: 	IMPORT_C TBool SourceIsData() const;
williamr@2: 	IMPORT_C const TDesC& SourceFilename() const;
williamr@2: 	IMPORT_C const TDesC8& SourceData() const;
williamr@2: 	IMPORT_C const TDesC8& SourceMimeType() const;
williamr@2: 	IMPORT_C const TUid SourceImageType() const;
williamr@2: 	IMPORT_C const TUid SourceImageSubType() const;
williamr@2: 	IMPORT_C TBool SourceRect(TRect& aRect) const;
williamr@2: 	IMPORT_C TBool DestIsFilename() const;
williamr@2: 	IMPORT_C TBool DestIsData() const;
williamr@2: 	IMPORT_C const TDesC& DestFilename() const;
williamr@2: 	IMPORT_C HBufC8*& DestData() const;
williamr@2: 	IMPORT_C const TSize& DestinationSizeInPixels() const;
williamr@2: 	IMPORT_C TUint Options() const;
williamr@2: 	IMPORT_C TBool MaintainAspectRatio() const;
williamr@2: 	IMPORT_C TBool PreserveImageData() const;
williamr@2: 	IMPORT_C virtual CImageTransformPluginExtension* Extension() const;
williamr@2: 
williamr@2: private:
williamr@2: 	IMPORT_C static CImageTransformPlugin* NewL(
williamr@2: 		TUid aImplementationUid, CImageTransformFramework& aFramework);
williamr@2: 
williamr@2: 	// Future proofing
williamr@2: 	IMPORT_C virtual void ReservedVirtual1();
williamr@2: 	IMPORT_C virtual void ReservedVirtual2();
williamr@2: 	IMPORT_C virtual void ReservedVirtual3();
williamr@2: 	IMPORT_C virtual void ReservedVirtual4();
williamr@2: 
williamr@2: private:
williamr@2: 	CImageTransformFramework* iFramework;
williamr@2: 	};
williamr@2: 
williamr@2: #endif // __IMAGETRANSFORMPLUGIN_H__