|
sl@0
|
1 |
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
/**
|
|
sl@0
|
17 |
@file
|
|
sl@0
|
18 |
@publishedPartner
|
|
sl@0
|
19 |
@prototype
|
|
sl@0
|
20 |
*/
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#ifndef DISPMAP_CLIENT_H_
|
|
sl@0
|
23 |
#define DISPMAP_CLIENT_H_
|
|
sl@0
|
24 |
#include <w32std.h>
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
/** Defines the coordinate space UID values for use with
|
|
sl@0
|
27 |
MDisplayMappingBase::MapCoordinates().
|
|
sl@0
|
28 |
*/
|
|
sl@0
|
29 |
enum TCoordinateSpace
|
|
sl@0
|
30 |
{
|
|
sl@0
|
31 |
/**
|
|
sl@0
|
32 |
Application coordinate space, possibly offset but not scaled
|
|
sl@0
|
33 |
relative to full-screen space.
|
|
sl@0
|
34 |
*/
|
|
sl@0
|
35 |
EApplicationSpace = 0x1028656F,
|
|
sl@0
|
36 |
/**
|
|
sl@0
|
37 |
User interface coordinate space, possibly scaled but not offset
|
|
sl@0
|
38 |
relative to composition space.
|
|
sl@0
|
39 |
*/
|
|
sl@0
|
40 |
EFullScreenSpace = 0x10286570,
|
|
sl@0
|
41 |
/**
|
|
sl@0
|
42 |
Composition coordinate space, used by composition back-end in
|
|
sl@0
|
43 |
compositing the display contents.
|
|
sl@0
|
44 |
*/
|
|
sl@0
|
45 |
ECompositionSpace = 0x10286571,
|
|
sl@0
|
46 |
/**
|
|
sl@0
|
47 |
Coordinate space for the DSA buffer. May be offset but not scaled
|
|
sl@0
|
48 |
relative to both application and full-screen spaces. Identical to
|
|
sl@0
|
49 |
full-screen space if the DSA buffer is used for UI rendering.
|
|
sl@0
|
50 |
*/
|
|
sl@0
|
51 |
EDirectScreenAccessSpace = 0x1028656E
|
|
sl@0
|
52 |
};
|
|
sl@0
|
53 |
|
|
sl@0
|
54 |
/** Provides facilities to map coordinates between various coordinate
|
|
sl@0
|
55 |
spaces.
|
|
sl@0
|
56 |
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
class MDisplayMappingBase
|
|
sl@0
|
59 |
{
|
|
sl@0
|
60 |
public:
|
|
sl@0
|
61 |
enum
|
|
sl@0
|
62 |
{
|
|
sl@0
|
63 |
KUidDisplayMappingBase = 0x1028656D,
|
|
sl@0
|
64 |
ETypeId= KUidDisplayMappingBase
|
|
sl@0
|
65 |
};
|
|
sl@0
|
66 |
public:
|
|
sl@0
|
67 |
/** Maps the source rectangle from a source coordinate space to a
|
|
sl@0
|
68 |
target coordinate space. Since there may be scaling involved, the
|
|
sl@0
|
69 |
target rectangle may be larger or smaller than the source one, or
|
|
sl@0
|
70 |
even become empty.
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
Two rectangles that abut each other before mapping, when mapped
|
|
sl@0
|
73 |
using the same source and target space UIDs, shall also abut each
|
|
sl@0
|
74 |
other after mapping.
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
@param aSourceSpace source space
|
|
sl@0
|
77 |
@param aSource source rectangle
|
|
sl@0
|
78 |
@param aTargetSpace target space
|
|
sl@0
|
79 |
@param aTarget target rectangle to be filled in
|
|
sl@0
|
80 |
@return KErrNone if successful or KErrNotSupported if invalid TCoordinateSpace
|
|
sl@0
|
81 |
*/
|
|
sl@0
|
82 |
virtual TInt MapCoordinates(TCoordinateSpace aSourceSpace, const TRect& aSource, TCoordinateSpace aTargetSpace, TRect& aTarget) const =0;
|
|
sl@0
|
83 |
};
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
/** Provides the Window Server client coordinate space mapping
|
|
sl@0
|
86 |
functions.
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
*/
|
|
sl@0
|
89 |
class MDisplayMapping : public MDisplayMappingBase
|
|
sl@0
|
90 |
{
|
|
sl@0
|
91 |
public:
|
|
sl@0
|
92 |
enum
|
|
sl@0
|
93 |
{
|
|
sl@0
|
94 |
KUidDisplayMapping = 0x1028656B,
|
|
sl@0
|
95 |
ETypeId= KUidDisplayMapping
|
|
sl@0
|
96 |
};
|
|
sl@0
|
97 |
public:
|
|
sl@0
|
98 |
/** Retrieves the largest window extent that is visible at the current
|
|
sl@0
|
99 |
display resolution. This may be larger than the size reported by
|
|
sl@0
|
100 |
SizeInPixels(), and have a negative top-left position, for example.
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
@see MDisplayControl
|
|
sl@0
|
103 |
@see CWsScreenDevice::SizeInPixels
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
@param aExtent extent to be filled in
|
|
sl@0
|
106 |
*/
|
|
sl@0
|
107 |
virtual void GetMaximumWindowExtent(TRect& aExtent) const =0;
|
|
sl@0
|
108 |
/** Returns the maximum useful size for a surface to be shown on the
|
|
sl@0
|
109 |
display at the current resolution, in both pixels and twips.
|
|
sl@0
|
110 |
|
|
sl@0
|
111 |
This may be larger than both the screen device SizeInPixels() and
|
|
sl@0
|
112 |
the size of the maximum window extent, if the user interface is
|
|
sl@0
|
113 |
being scaled by the display. In general, the value will be the
|
|
sl@0
|
114 |
native display resolution.
|
|
sl@0
|
115 |
|
|
sl@0
|
116 |
@see MDisplayControl
|
|
sl@0
|
117 |
@see CWsScreenDevice::SizeInPixels
|
|
sl@0
|
118 |
|
|
sl@0
|
119 |
@param aPixels pixels to be filled in
|
|
sl@0
|
120 |
@param aTwips twips to be filled in
|
|
sl@0
|
121 |
*/
|
|
sl@0
|
122 |
virtual void GetMaximumSurfaceSize(TSize& aPixels, TSize& aTwips) const =0;
|
|
sl@0
|
123 |
/** Retrieves the extent of a window relative to the top-left corner of
|
|
sl@0
|
124 |
the display.
|
|
sl@0
|
125 |
|
|
sl@0
|
126 |
This will differ from the window's AbsPosition() if the current
|
|
sl@0
|
127 |
screen size mode is offset from the corner of the display, or if
|
|
sl@0
|
128 |
the user interface is being scaled on the display.
|
|
sl@0
|
129 |
|
|
sl@0
|
130 |
@param aWindow window in question
|
|
sl@0
|
131 |
@param aExtent extent to be filled in
|
|
sl@0
|
132 |
*/
|
|
sl@0
|
133 |
virtual void GetDisplayExtentOfWindow(const RWindowBase& aWindow, TRect& aExtent) const =0;
|
|
sl@0
|
134 |
};
|
|
sl@0
|
135 |
|
|
sl@0
|
136 |
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
#endif /*DISPMAP_CLIENT_H_*/
|