1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
22 #ifndef DISPMAP_CLIENT_H_
23 #define DISPMAP_CLIENT_H_
26 /** Defines the coordinate space UID values for use with
27 MDisplayMappingBase::MapCoordinates().
32 Application coordinate space, possibly offset but not scaled
33 relative to full-screen space.
35 EApplicationSpace = 0x1028656F,
37 User interface coordinate space, possibly scaled but not offset
38 relative to composition space.
40 EFullScreenSpace = 0x10286570,
42 Composition coordinate space, used by composition back-end in
43 compositing the display contents.
45 ECompositionSpace = 0x10286571,
47 Coordinate space for the DSA buffer. May be offset but not scaled
48 relative to both application and full-screen spaces. Identical to
49 full-screen space if the DSA buffer is used for UI rendering.
51 EDirectScreenAccessSpace = 0x1028656E
54 /** Provides facilities to map coordinates between various coordinate
58 class MDisplayMappingBase
63 KUidDisplayMappingBase = 0x1028656D,
64 ETypeId= KUidDisplayMappingBase
67 /** Maps the source rectangle from a source coordinate space to a
68 target coordinate space. Since there may be scaling involved, the
69 target rectangle may be larger or smaller than the source one, or
72 Two rectangles that abut each other before mapping, when mapped
73 using the same source and target space UIDs, shall also abut each
76 @param aSourceSpace source space
77 @param aSource source rectangle
78 @param aTargetSpace target space
79 @param aTarget target rectangle to be filled in
80 @return KErrNone if successful or KErrNotSupported if invalid TCoordinateSpace
82 virtual TInt MapCoordinates(TCoordinateSpace aSourceSpace, const TRect& aSource, TCoordinateSpace aTargetSpace, TRect& aTarget) const =0;
85 /** Provides the Window Server client coordinate space mapping
89 class MDisplayMapping : public MDisplayMappingBase
94 KUidDisplayMapping = 0x1028656B,
95 ETypeId= KUidDisplayMapping
98 /** Retrieves the largest window extent that is visible at the current
99 display resolution. This may be larger than the size reported by
100 SizeInPixels(), and have a negative top-left position, for example.
103 @see CWsScreenDevice::SizeInPixels
105 @param aExtent extent to be filled in
107 virtual void GetMaximumWindowExtent(TRect& aExtent) const =0;
108 /** Returns the maximum useful size for a surface to be shown on the
109 display at the current resolution, in both pixels and twips.
111 This may be larger than both the screen device SizeInPixels() and
112 the size of the maximum window extent, if the user interface is
113 being scaled by the display. In general, the value will be the
114 native display resolution.
117 @see CWsScreenDevice::SizeInPixels
119 @param aPixels pixels to be filled in
120 @param aTwips twips to be filled in
122 virtual void GetMaximumSurfaceSize(TSize& aPixels, TSize& aTwips) const =0;
123 /** Retrieves the extent of a window relative to the top-left corner of
126 This will differ from the window's AbsPosition() if the current
127 screen size mode is offset from the corner of the display, or if
128 the user interface is being scaled on the display.
130 @param aWindow window in question
131 @param aExtent extent to be filled in
133 virtual void GetDisplayExtentOfWindow(const RWindowBase& aWindow, TRect& aExtent) const =0;
138 #endif /*DISPMAP_CLIENT_H_*/