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:  @file
sl@0:  @publishedPartner
sl@0:  @prototype
sl@0: */
sl@0: 
sl@0: #ifndef DISPMAP_CLIENT_H_
sl@0: #define DISPMAP_CLIENT_H_
sl@0: #include <w32std.h>
sl@0: 
sl@0: /** Defines the coordinate space UID values for use with
sl@0: 	MDisplayMappingBase::MapCoordinates().
sl@0: */
sl@0: enum TCoordinateSpace
sl@0: 		{
sl@0: 	/**
sl@0: 		Application coordinate space, possibly offset but not scaled
sl@0: 		relative to full-screen space.
sl@0: 	 */
sl@0: 	EApplicationSpace = 0x1028656F,
sl@0: 	/**
sl@0: 		User interface coordinate space, possibly scaled but not offset
sl@0: 		relative to composition space.
sl@0: 	*/
sl@0: 	EFullScreenSpace = 0x10286570,
sl@0: 	/**
sl@0: 		Composition coordinate space, used by composition back-end in
sl@0: 		compositing the display contents.
sl@0: 	*/
sl@0: 	ECompositionSpace = 0x10286571,
sl@0: 	/**
sl@0: 		Coordinate space for the DSA buffer. May be offset but not scaled
sl@0: 		relative to both application and full-screen spaces. Identical to
sl@0: 		full-screen space if the DSA buffer is used for UI rendering.
sl@0: 	*/
sl@0: 	EDirectScreenAccessSpace = 0x1028656E
sl@0: 	};
sl@0: 
sl@0: /** Provides facilities to map coordinates between various coordinate
sl@0: 	spaces.
sl@0: 
sl@0: */
sl@0: class MDisplayMappingBase
sl@0: 	{
sl@0: public:
sl@0: 	enum	
sl@0: 		{
sl@0: 		KUidDisplayMappingBase =  0x1028656D, 	  
sl@0: 		ETypeId=	 KUidDisplayMappingBase 
sl@0: 		};
sl@0: public:
sl@0: 	/** Maps the source rectangle from a source coordinate space to a
sl@0: 		target coordinate space. Since there may be scaling involved, the
sl@0: 		target rectangle may be larger or smaller than the source one, or
sl@0: 		even become empty.
sl@0: 
sl@0: 		Two rectangles that abut each other before mapping, when mapped
sl@0: 		using the same source and target space UIDs, shall also abut each
sl@0: 		other after mapping.
sl@0: 
sl@0: 		@param aSourceSpace source space
sl@0: 		@param aSource source rectangle
sl@0: 		@param aTargetSpace target space
sl@0: 		@param aTarget target rectangle to be filled in
sl@0: 		@return KErrNone if successful or KErrNotSupported if invalid TCoordinateSpace
sl@0: 	*/
sl@0: 	virtual TInt MapCoordinates(TCoordinateSpace aSourceSpace, const TRect& aSource, TCoordinateSpace aTargetSpace, TRect& aTarget) const =0;
sl@0: 	};
sl@0: 
sl@0: /** Provides the Window Server client coordinate space mapping
sl@0: 	functions.
sl@0: 
sl@0: */
sl@0: class MDisplayMapping : public MDisplayMappingBase
sl@0: 	{
sl@0: public:
sl@0: 	enum	
sl@0: 		{
sl@0: 		KUidDisplayMapping =  0x1028656B, 	  
sl@0: 		ETypeId=	 KUidDisplayMapping 
sl@0: 		};
sl@0: public:
sl@0: 	/** Retrieves the largest window extent that is visible at the current
sl@0: 		display resolution. This may be larger than the size reported by
sl@0: 		SizeInPixels(), and have a negative top-left position, for example.
sl@0: 
sl@0: 		@see MDisplayControl
sl@0: 		@see CWsScreenDevice::SizeInPixels
sl@0: 
sl@0: 	 	@param aExtent extent to be filled in
sl@0: 	*/
sl@0: 	virtual void GetMaximumWindowExtent(TRect& aExtent) const =0;
sl@0: 	/** Returns the maximum useful size for a surface to be shown on the
sl@0: 		display at the current resolution, in both pixels and twips.
sl@0: 
sl@0: 		This may be larger than both the screen device SizeInPixels() and
sl@0: 		the size of the maximum window extent, if the user interface is
sl@0: 		being scaled by the display. In general, the value will be the
sl@0: 		native display resolution.
sl@0: 
sl@0: 		@see MDisplayControl
sl@0: 		@see CWsScreenDevice::SizeInPixels
sl@0: 		
sl@0: 		@param aPixels pixels to be filled in
sl@0: 		@param aTwips twips to be filled in
sl@0: 	*/
sl@0: 	virtual void GetMaximumSurfaceSize(TSize& aPixels, TSize& aTwips) const =0;
sl@0: 	/** Retrieves the extent of a window relative to the top-left corner of
sl@0: 		the display.
sl@0: 
sl@0: 		This will differ from the window's AbsPosition() if the current
sl@0: 		screen size mode is offset from the corner of the display, or if
sl@0: 		the user interface is being scaled on the display.
sl@0: 
sl@0: 		@param aWindow window in question
sl@0: 		@param aExtent extent to be filled in
sl@0: 	*/
sl@0: 	virtual void GetDisplayExtentOfWindow(const RWindowBase& aWindow, TRect& aExtent) const =0;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: #endif 	/*DISPMAP_CLIENT_H_*/