1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/graphics/windowing/windowserver/inc/Graphics/wsdrawablesourceprovider.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,97 @@
     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 +//
    1.18 +
    1.19 +/**
    1.20 + @publishedPartner
    1.21 + @prototype
    1.22 +*/
    1.23 +
    1.24 +#ifndef __WSDRAWABLESOURCEPROVIDER_H__
    1.25 +#define __WSDRAWABLESOURCEPROVIDER_H__
    1.26 +
    1.27 +#include <graphics/sgresource.h>
    1.28 +#include <graphics/wsgraphicdrawerinterface.h>
    1.29 +
    1.30 +/**
    1.31 +Window server evokes this interface from rendering stage plugin every time client 
    1.32 +requests resource drawing operations.
    1.33 +
    1.34 +@publishedPartner
    1.35 +@prototype
    1.36 + */
    1.37 +class MWsDrawableSourceProvider : public MWsObjectProvider
    1.38 +	{
    1.39 +public:
    1.40 +	DECLARE_WS_TYPE_ID(KMWsDrawableSourceProvider)
    1.41 +public:
    1.42 +	/**
    1.43 +	 Create a source object for future drawing of the drawable resource with the specified ID.
    1.44 +	 @param aDrawableId The ID of the drawable resource.
    1.45 +	 @param aSource On output, a pointer to the new source object associated with the drawable resource,
    1.46 +	                which must be passed in calls to DrawResource() and CloseDrawableSource().
    1.47 +	      	        After the call to CloseDrawableSource() the source object is destroyed and this pointer becomes invalid.
    1.48 +	      	        The type of the source object is defined by the implementation of MWsDrawableSourceProvider.
    1.49 +	 @post If successful, a new source object is created and the associated drawable resource is ready to use.
    1.50 +	 @return KErrNone if successful, otherwise one of the system-wide error codes.
    1.51 +	 */
    1.52 +	virtual TInt CreateDrawableSource(const TSgDrawableId& aDrawableId, TAny*& aSource) = 0;
    1.53 +
    1.54 +	/**
    1.55 +	 Destroy a source object associated with a drawable resource.
    1.56 +	 @param aSource A pointer to a source object created by a previous call to CreateDrawableSource().
    1.57 +	 @post Drawing of the associated drawable resource is no longer possible.
    1.58 +	 @return KErrNone if successful, otherwise one of the system-wide error codes.
    1.59 +	 */
    1.60 +	virtual void CloseDrawableSource(TAny* aSource) = 0;
    1.61 +
    1.62 +	/**
    1.63 +	 Draw a graphics resource.
    1.64 +	 @param aSource A pointer to the source object associated with the drawable resource.
    1.65 +	 @param aPos Destination position for the top-left corner of the drawable resource.
    1.66 +	 @param	aRotation Rotation to be applied to the drawable resource before it is drawn.
    1.67 +	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
    1.68 +	 */
    1.69 +	virtual void DrawResource(const TAny* aSource, const TPoint& aPos, CWindowGc::TGraphicsRotation aRotation = CWindowGc::EGraphicsRotationNone) = 0;
    1.70 +
    1.71 +	/**
    1.72 +	 Draw a graphics resource.
    1.73 +	 @param aSource A pointer to the source object associated with the drawable resource.
    1.74 +	 @param aRect Destination rectangle. The drawable resource could be scaled if its size doesn't match the destination rectangle.
    1.75 +	 @param	aRotation Rotation to be applied to the drawable resource before it is drawn.
    1.76 +	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
    1.77 +	 */
    1.78 +	virtual void DrawResource(const TAny* aSource, const TRect& aRect, CWindowGc::TGraphicsRotation aRotation = CWindowGc::EGraphicsRotationNone) = 0;
    1.79 +
    1.80 +	/**
    1.81 +	 Draw a graphics resource.
    1.82 +	 @param aSource A pointer to the source object associated with the drawable resource.
    1.83 +	 @param aRectDest Destination rectangle. The drawable resource could be scaled if its size doesn't match the destination rectangle.
    1.84 +	 @param aRectSrc A rectangle defining the piece of the drawable resource to be drawn, in the co-ordinate system of the drawable resource.
    1.85 +	 @param	aRotation Rotation to be applied to the drawable resource before it is drawn.
    1.86 +	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
    1.87 +	 */
    1.88 +	virtual void DrawResource(const TAny* aSource, const TRect& aRectDest, const TRect& aRectSrc, CWindowGc::TGraphicsRotation aRotation = CWindowGc::EGraphicsRotationNone) = 0;
    1.89 +
    1.90 +	/**
    1.91 +	 Draw a graphics resource.
    1.92 +	 @param aSource A pointer to the source object associated with the drawable resource.
    1.93 +	 @param aRect Destination rectangle. The drawable resource could be scaled if its size doesn't match the destination rectangle.
    1.94 +	 @param	aParam Parameters specifying how to draw the drawable resource.
    1.95 +	 @pre A source object must have been created for the drawable resource by a previous call to CreateDrawableSource().
    1.96 +	 */
    1.97 +	virtual void DrawResource(const TAny* aSource, const TRect& aRect, const TDesC8& aParam) = 0;
    1.98 +	};
    1.99 +
   1.100 +#endif //__WSDRAWABLESOURCEPROVIDER_H__