sl@0: // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @publishedPartner
sl@0:  @prototype
sl@0: */
sl@0: 
sl@0: #ifndef __WSDRAWABLESOURCEPROVIDER_H__
sl@0: #define __WSDRAWABLESOURCEPROVIDER_H__
sl@0: 
sl@0: #include <graphics/sgresource.h>
sl@0: #include <graphics/wsgraphicdrawerinterface.h>
sl@0: 
sl@0: /**
sl@0: Window server evokes this interface from rendering stage plugin every time client 
sl@0: requests resource drawing operations.
sl@0: 
sl@0: @publishedPartner
sl@0: @prototype
sl@0:  */
sl@0: class MWsDrawableSourceProvider : public MWsObjectProvider
sl@0: 	{
sl@0: public:
sl@0: 	DECLARE_WS_TYPE_ID(KMWsDrawableSourceProvider)
sl@0: public:
sl@0: 	/**
sl@0: 	 Create a source object for future drawing of the drawable resource with the specified ID.
sl@0: 	 @param aDrawableId The ID of the drawable resource.
sl@0: 	 @param aSource On output, a pointer to the new source object associated with the drawable resource,
sl@0: 	                which must be passed in calls to DrawResource() and CloseDrawableSource().
sl@0: 	      	        After the call to CloseDrawableSource() the source object is destroyed and this pointer becomes invalid.
sl@0: 	      	        The type of the source object is defined by the implementation of MWsDrawableSourceProvider.
sl@0: 	 @post If successful, a new source object is created and the associated drawable resource is ready to use.
sl@0: 	 @return KErrNone if successful, otherwise one of the system-wide error codes.
sl@0: 	 */
sl@0: 	virtual TInt CreateDrawableSource(const TSgDrawableId& aDrawableId, TAny*& aSource) = 0;
sl@0: 
sl@0: 	/**
sl@0: 	 Destroy a source object associated with a drawable resource.
sl@0: 	 @param aSource A pointer to a source object created by a previous call to CreateDrawableSource().
sl@0: 	 @post Drawing of the associated drawable resource is no longer possible.
sl@0: 	 @return KErrNone if successful, otherwise one of the system-wide error codes.
sl@0: 	 */
sl@0: 	virtual void CloseDrawableSource(TAny* aSource) = 0;
sl@0: 
sl@0: 	/**
sl@0: 	 Draw a graphics resource.
sl@0: 	 @param aSource A pointer to the source object associated with the drawable resource.
sl@0: 	 @param aPos Destination position for the top-left corner of the drawable resource.
sl@0: 	 @param	aRotation Rotation to be applied to the drawable resource before it is drawn.
sl@0: 	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
sl@0: 	 */
sl@0: 	virtual void DrawResource(const TAny* aSource, const TPoint& aPos, CWindowGc::TGraphicsRotation aRotation = CWindowGc::EGraphicsRotationNone) = 0;
sl@0: 
sl@0: 	/**
sl@0: 	 Draw a graphics resource.
sl@0: 	 @param aSource A pointer to the source object associated with the drawable resource.
sl@0: 	 @param aRect Destination rectangle. The drawable resource could be scaled if its size doesn't match the destination rectangle.
sl@0: 	 @param	aRotation Rotation to be applied to the drawable resource before it is drawn.
sl@0: 	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
sl@0: 	 */
sl@0: 	virtual void DrawResource(const TAny* aSource, const TRect& aRect, CWindowGc::TGraphicsRotation aRotation = CWindowGc::EGraphicsRotationNone) = 0;
sl@0: 
sl@0: 	/**
sl@0: 	 Draw a graphics resource.
sl@0: 	 @param aSource A pointer to the source object associated with the drawable resource.
sl@0: 	 @param aRectDest Destination rectangle. The drawable resource could be scaled if its size doesn't match the destination rectangle.
sl@0: 	 @param aRectSrc A rectangle defining the piece of the drawable resource to be drawn, in the co-ordinate system of the drawable resource.
sl@0: 	 @param	aRotation Rotation to be applied to the drawable resource before it is drawn.
sl@0: 	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
sl@0: 	 */
sl@0: 	virtual void DrawResource(const TAny* aSource, const TRect& aRectDest, const TRect& aRectSrc, CWindowGc::TGraphicsRotation aRotation = CWindowGc::EGraphicsRotationNone) = 0;
sl@0: 
sl@0: 	/**
sl@0: 	 Draw a graphics resource.
sl@0: 	 @param aSource A pointer to the source object associated with the drawable resource.
sl@0: 	 @param aRect Destination rectangle. The drawable resource could be scaled if its size doesn't match the destination rectangle.
sl@0: 	 @param	aParam Parameters specifying how to draw the drawable resource.
sl@0: 	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
sl@0: 	 */
sl@0: 	virtual void DrawResource(const TAny* aSource, const TRect& aRect, const TDesC8& aParam) = 0;
sl@0: 	};
sl@0: 
sl@0: #endif //__WSDRAWABLESOURCEPROVIDER_H__