1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/icl/overlaytransformextension.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,77 @@
     1.4 +// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// This is Image Transform extension for Overlay/Replace transformations
    1.18 +// 
    1.19 +//
    1.20 +
    1.21 +/**
    1.22 + @file
    1.23 + @publishedAll 
    1.24 + @released
    1.25 +*/
    1.26 +
    1.27 +#ifndef __OVERLAYTRANFORMEEXTENSION_H__
    1.28 +#define __OVERLAYTRANFORMEEXTENSION_H__
    1.29 +
    1.30 +#include <e32base.h>
    1.31 +#include <e32cmn.h>
    1.32 +#include <icl/imagetransformpluginext.h>
    1.33 +
    1.34 +//fwd decl
    1.35 +class CFbsBitmap;
    1.36 +class CImageFrame;
    1.37 +
    1.38 +/**
    1.39 +@publishedAll 
    1.40 +@released
    1.41 +
    1.42 +Overlay/Replace Extension to the ImageTransform plugin
    1.43 +
    1.44 +The class provides the methods to set the overlay/replace parameters and is intended to be implemented
    1.45 +by the plugins supporting the blending of the images. The client can set the overlay image, the overlay 
    1.46 +position and the transparency of the overlay image. The plugin supporting this extension must use 
    1.47 +the opaque_data v2 format in RSS file and also the overlay flag must be set in the opaque_data.
    1.48 +The client must retrieve this extension implementation from the plugin using its extension UID.
    1.49 +*/
    1.50 +class COverlayTransformExtension : public CImageTransformPluginExtension
    1.51 +	{
    1.52 +public:
    1.53 +	IMPORT_C void SetPosition(const TPoint& aPosition);
    1.54 +	IMPORT_C void SetTransparencyLevelL(TUint aLevel);
    1.55 +	IMPORT_C void SetOverlayFileL(const TDesC& aFilename, const TUid& aOverlayImageUid);
    1.56 +	IMPORT_C void SetOverlayDataL(const TDesC8& aData, const TUid& aOverlayImageUid);
    1.57 +	IMPORT_C void SetOverlayImageL(const CFbsBitmap& aBitmap);
    1.58 +	IMPORT_C void SetOverlayImageL(const CImageFrame& aImageFrame);
    1.59 +	IMPORT_C void SupportedOverlayInputFormatsL(RArray<TUid>& aFormats) const;
    1.60 +	IMPORT_C void SupportedOverlayInputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats) const;
    1.61 +	
    1.62 +protected:
    1.63 +	virtual void DoSetPosition(const TPoint& aPosition) = 0;
    1.64 +	virtual void DoSetTransparencyLevelL(TUint aLevel) = 0;
    1.65 +	virtual void DoSetOverlayFileL(const TDesC& aFilename, const TUid& aOverlayImageUid) = 0;
    1.66 +	virtual void DoSetOverlayDataL(const TDesC8& aData, const TUid& aOverlayImageUid) =0;
    1.67 +	virtual void DoSetOverlayImageL(const CFbsBitmap& aBitmap) =0;
    1.68 +	virtual void DoSetOverlayImageL(const CImageFrame& aImageFrame) =0;
    1.69 +	virtual void DoSupportedOverlayInputFormatsL(RArray<TUid>& aFormats) const =0;
    1.70 +	virtual void DoSupportedOverlayInputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats) const = 0;
    1.71 +
    1.72 +private:
    1.73 +	IMPORT_C virtual void ReservedVirtual5();
    1.74 +
    1.75 +private:	
    1.76 +	// Future proofing
    1.77 +	TAny* iPad;
    1.78 +	};
    1.79 +
    1.80 +#endif // __OVERLAYTRANFORMEEXTENSION_H__