|
sl@0
|
1 |
// Copyright (c) 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 |
// Interface for Scene Elements
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@publishedPartner
|
|
sl@0
|
20 |
@prototype
|
|
sl@0
|
21 |
*/
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#ifndef WSELEMENT_H
|
|
sl@0
|
24 |
#define WSELEMENT_H
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
#include <w32std.h>
|
|
sl@0
|
27 |
#include <graphics/wsgraphicdrawerinterface.h>
|
|
sl@0
|
28 |
#include <graphics/surface.h>
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
/**
|
|
sl@0
|
31 |
* @brief Window Server Scene Element Interface Definition
|
|
sl@0
|
32 |
*
|
|
sl@0
|
33 |
* This interface allows Image Sources to be associated with meta-data
|
|
sl@0
|
34 |
* to define how the Image Source must be presented within a Scene.
|
|
sl@0
|
35 |
*
|
|
sl@0
|
36 |
* For a conceptual overview of Scenes, refer to the @c MWsScene Interface.
|
|
sl@0
|
37 |
*
|
|
sl@0
|
38 |
* The following aspects of Image Source presentation may be controlled:
|
|
sl@0
|
39 |
* @li Source rectangular region
|
|
sl@0
|
40 |
* @li Destination rectangular region
|
|
sl@0
|
41 |
* @li Rotation and flipping
|
|
sl@0
|
42 |
* @li Opacity
|
|
sl@0
|
43 |
* @li Relative z-order (ordinal position)
|
|
sl@0
|
44 |
* @li Tags to descriminate the UI from other Elements
|
|
sl@0
|
45 |
*
|
|
sl@0
|
46 |
* All co-ordinates are pixels offsets from (0,0) representing the
|
|
sl@0
|
47 |
* top level of the Image Source or Destination Target (the screen
|
|
sl@0
|
48 |
* or an off-screen buffer representing the screen), moving rightwards
|
|
sl@0
|
49 |
* and downwards in x and y co-ordinates respectively.
|
|
sl@0
|
50 |
*
|
|
sl@0
|
51 |
* Elements can be marked with flags. There are two different consumers
|
|
sl@0
|
52 |
* of flags: Target Renderers and Render Stage Plug-ins.
|
|
sl@0
|
53 |
*
|
|
sl@0
|
54 |
* Target Renderers are sub-systems which actually do composition and
|
|
sl@0
|
55 |
* rendering on a particular display device or off-screen buffer.
|
|
sl@0
|
56 |
* The EElementTransparencySource flag tells the Target Renderer that
|
|
sl@0
|
57 |
* alpha blending must use the alpha channel in the Surface connected to
|
|
sl@0
|
58 |
* the Element.
|
|
sl@0
|
59 |
*
|
|
sl@0
|
60 |
* On the other hand, Render Stage Plug-ins need flags to implement
|
|
sl@0
|
61 |
* specific policies such as "UI always on top". To facilitate this,
|
|
sl@0
|
62 |
* Elements have a EElementIsIndirectlyRenderedUserInterface or a
|
|
sl@0
|
63 |
* EElementIsDirectlyRenderedUserInterface optionally set. This
|
|
sl@0
|
64 |
* flag allows Render Stage Plug-ins to keep the relative z-order
|
|
sl@0
|
65 |
* of Elements aligned to this policy.
|
|
sl@0
|
66 |
*
|
|
sl@0
|
67 |
* To allow compatible updates to be made to flags, all Render Stage
|
|
sl@0
|
68 |
* Plug-ins must preserve the flags in Elements which they do not operate
|
|
sl@0
|
69 |
* upon. Target Renderers may ignore the flags in Elements which they
|
|
sl@0
|
70 |
* do not operate on.
|
|
sl@0
|
71 |
*
|
|
sl@0
|
72 |
* <h2>Intial State</h2>
|
|
sl@0
|
73 |
*
|
|
sl@0
|
74 |
* The initial state for an Element is:
|
|
sl@0
|
75 |
* @li Fully opaque
|
|
sl@0
|
76 |
* @li No rotation, nor flipped
|
|
sl@0
|
77 |
* @li Not part of the Committed Scene
|
|
sl@0
|
78 |
* @li No connected Surface
|
|
sl@0
|
79 |
* @li All flags reset
|
|
sl@0
|
80 |
* @li Local error value set as KErrNone
|
|
sl@0
|
81 |
* @li Source Rectangle and Destination Rectangle is (0,0,0,0)
|
|
sl@0
|
82 |
* @il Destination Clipping Rectangle is (0,0,0,0)
|
|
sl@0
|
83 |
*
|
|
sl@0
|
84 |
* When an Image Source is connected, the initial state becomes:
|
|
sl@0
|
85 |
* @li Source Rectangle is the extent of the Image Source
|
|
sl@0
|
86 |
* @li Destination Rectangle is set at origin (0,0), whose sized equals the
|
|
sl@0
|
87 |
* Image Source size truncated the the target screen size.
|
|
sl@0
|
88 |
* @li Destination Clipping Rectangle is (0,0,0,0) to represent the entire
|
|
sl@0
|
89 |
* area of the target screen.
|
|
sl@0
|
90 |
*
|
|
sl@0
|
91 |
* <h2>Special Rectangle Values</h2>
|
|
sl@0
|
92 |
*
|
|
sl@0
|
93 |
* Sometimes it is desirable to reset a Source, Destination, or Clipping
|
|
sl@0
|
94 |
* Rectangle so that the actual value used matches the corresponding Source
|
|
sl@0
|
95 |
* Image or Target Screen size. In such cases rectangle (0,0,0,0) is used to
|
|
sl@0
|
96 |
* represent this.
|
|
sl@0
|
97 |
*
|
|
sl@0
|
98 |
* <h2>Extending this interface</h2>
|
|
sl@0
|
99 |
*
|
|
sl@0
|
100 |
* This interface can be extended in two different ways
|
|
sl@0
|
101 |
* @li Creating optional extension interfaces with
|
|
sl@0
|
102 |
* MWsElement::MWsObjectProvider::ResolveObjectInterface()
|
|
sl@0
|
103 |
* @li Defining new TElementFlags flag settings; Render Stage Plug-ins
|
|
sl@0
|
104 |
* preserve the value of these across the Render Stage Pipeline.
|
|
sl@0
|
105 |
*
|
|
sl@0
|
106 |
* <h2>Committed Elements versus Pending Elements</h2>
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* This interface allows Elements to be modified in terms of their
|
|
sl@0
|
109 |
* own flag settings, and rotation, as well as their relative position
|
|
sl@0
|
110 |
* with other Elements. Queries return the pending values for such
|
|
sl@0
|
111 |
* Elements. Any modifications are marked Pending, and affect the Scene
|
|
sl@0
|
112 |
* according to the rules described by "Rendering" in @c MWsScene.
|
|
sl@0
|
113 |
*
|
|
sl@0
|
114 |
* <h2>Order in which transformations are applied</h2>
|
|
sl@0
|
115 |
*
|
|
sl@0
|
116 |
* A number of different transformations may be specified for an Element.
|
|
sl@0
|
117 |
* The order in which these are applied to arrive at the view seen in
|
|
sl@0
|
118 |
* the target is:
|
|
sl@0
|
119 |
* -# SetSourceRectangle (Cropping)
|
|
sl@0
|
120 |
* -# SetSourceFlipping (Flipping)
|
|
sl@0
|
121 |
* -# SetSourceRotation (Rotation)
|
|
sl@0
|
122 |
* -# SetDestinationRectangle (Scaling and Positioning)
|
|
sl@0
|
123 |
* -# SetDestinationClippingRectangle (Scaling and Positioning)
|
|
sl@0
|
124 |
* -# SetGlobalAlpha (Blending)
|
|
sl@0
|
125 |
*/
|
|
sl@0
|
126 |
class MWsElement : public MWsObjectProvider
|
|
sl@0
|
127 |
{
|
|
sl@0
|
128 |
public:
|
|
sl@0
|
129 |
|
|
sl@0
|
130 |
/**
|
|
sl@0
|
131 |
* @brief Flags used by Target Renderers.
|
|
sl@0
|
132 |
*/
|
|
sl@0
|
133 |
enum TElementTargetRendererFlags
|
|
sl@0
|
134 |
{
|
|
sl@0
|
135 |
/**
|
|
sl@0
|
136 |
* Target renderer must treat the Element as Opaque.
|
|
sl@0
|
137 |
*/
|
|
sl@0
|
138 |
EElementTransparencyNone = 0,
|
|
sl@0
|
139 |
/**
|
|
sl@0
|
140 |
* Target renderer must use the Global Alpha Transparency value
|
|
sl@0
|
141 |
* from the Element
|
|
sl@0
|
142 |
*/
|
|
sl@0
|
143 |
EElementTransparencyGlobalAlpha = (1 << 0),
|
|
sl@0
|
144 |
/**
|
|
sl@0
|
145 |
* Target renderer must use the Alpha Transparency Channel from
|
|
sl@0
|
146 |
* the Element
|
|
sl@0
|
147 |
*/
|
|
sl@0
|
148 |
EElementTransparencySource = (1 << 1),
|
|
sl@0
|
149 |
/**
|
|
sl@0
|
150 |
* Reserved flag value; this must not be set.
|
|
sl@0
|
151 |
*/
|
|
sl@0
|
152 |
EElementTargetRendererReserved = (1 << 2)
|
|
sl@0
|
153 |
};
|
|
sl@0
|
154 |
|
|
sl@0
|
155 |
/**
|
|
sl@0
|
156 |
* @brief Flags used by Render Stages.
|
|
sl@0
|
157 |
*/
|
|
sl@0
|
158 |
enum TElementRenderStageFlags
|
|
sl@0
|
159 |
{
|
|
sl@0
|
160 |
/**
|
|
sl@0
|
161 |
* No flag value set for Render Stage Plug-in
|
|
sl@0
|
162 |
*/
|
|
sl@0
|
163 |
EElementRenderStageNone = 0,
|
|
sl@0
|
164 |
/**
|
|
sl@0
|
165 |
* Indirectly Rendered User Interface, i.e. rendering via
|
|
sl@0
|
166 |
* MWsGraphicsContext calls originating from client CWindowGc
|
|
sl@0
|
167 |
* commands
|
|
sl@0
|
168 |
*/
|
|
sl@0
|
169 |
EElementIsIndirectlyRenderedUserInterface = (1 << 0),
|
|
sl@0
|
170 |
/**
|
|
sl@0
|
171 |
* Directly Render User Interface, i.e. rendering where Window
|
|
sl@0
|
172 |
* Server does not see the graphics commands, as is the case for
|
|
sl@0
|
173 |
* Direct Screen Access clients.
|
|
sl@0
|
174 |
*/
|
|
sl@0
|
175 |
EElementIsDirectlyRenderedUserInterface = (1 << 1),
|
|
sl@0
|
176 |
/**
|
|
sl@0
|
177 |
* Reserved values for future Render Stage Plug-in usage
|
|
sl@0
|
178 |
*/
|
|
sl@0
|
179 |
EElementRenderStageReserved = (1 << 2)
|
|
sl@0
|
180 |
};
|
|
sl@0
|
181 |
|
|
sl@0
|
182 |
/**
|
|
sl@0
|
183 |
* Amount of rotation of pixel data to apply to the Image Source
|
|
sl@0
|
184 |
* to obtain the Target Image
|
|
sl@0
|
185 |
*/
|
|
sl@0
|
186 |
enum TElementRotation
|
|
sl@0
|
187 |
{
|
|
sl@0
|
188 |
EElementAntiClockwise0 = 0, /** No rotation */
|
|
sl@0
|
189 |
EElementAntiClockwise90 = 1, /** 90 Degrees Anti-clockwise in target */
|
|
sl@0
|
190 |
EElementAntiClockwise180 = 2, /** 180 Degrees Anti-clockwise in target */
|
|
sl@0
|
191 |
EElementAntiClockwise270 = 3 /** 270 Degrees Anti-clockwise in target */
|
|
sl@0
|
192 |
};
|
|
sl@0
|
193 |
|
|
sl@0
|
194 |
public:
|
|
sl@0
|
195 |
/**
|
|
sl@0
|
196 |
* @brief Set which portion of the image source is used.
|
|
sl@0
|
197 |
*
|
|
sl@0
|
198 |
* Set which rectangular portion of the connected image source
|
|
sl@0
|
199 |
* will be used when displaying this Element.
|
|
sl@0
|
200 |
*
|
|
sl@0
|
201 |
* @param aSrc The source rectangle of pixels from the connected Image Source.
|
|
sl@0
|
202 |
* This rectangle must not include any pixels outside the Image
|
|
sl@0
|
203 |
* Source. (0,0,0,0) means the entire size of the Image Source.
|
|
sl@0
|
204 |
* @pre An Image Source must have been connected; @see ConnectSurface()
|
|
sl@0
|
205 |
* @return One of the system-wide error codes.
|
|
sl@0
|
206 |
* KErrGeneral, if there is no image source connected.
|
|
sl@0
|
207 |
* KErrArgument, if the source rectangle includes pixels not in the
|
|
sl@0
|
208 |
* connected image source, or has negative width or height.
|
|
sl@0
|
209 |
* KErrNone, if successful.
|
|
sl@0
|
210 |
*/
|
|
sl@0
|
211 |
virtual TInt SetSourceRectangle(const TRect& aSrc) = 0;
|
|
sl@0
|
212 |
|
|
sl@0
|
213 |
/**
|
|
sl@0
|
214 |
* @brief Get the portion of the Image Source being used.
|
|
sl@0
|
215 |
*
|
|
sl@0
|
216 |
* Get the portion of the connected Image Source being used. The default
|
|
sl@0
|
217 |
* value is the entire extent of the connected Image Source.
|
|
sl@0
|
218 |
*
|
|
sl@0
|
219 |
* @param aSrc The source rectangle is updated with the current rectangular
|
|
sl@0
|
220 |
* region being used within the Image Source.
|
|
sl@0
|
221 |
* @pre An Image Source must have been connected; @see ConnectSurface()
|
|
sl@0
|
222 |
* @return One of the system-wide error codes.
|
|
sl@0
|
223 |
* KErrGeneral, if no Image Source has been connected.
|
|
sl@0
|
224 |
* KErrNone, if successful.
|
|
sl@0
|
225 |
*/
|
|
sl@0
|
226 |
virtual TInt GetSourceRectangle(TRect& aSrc) = 0;
|
|
sl@0
|
227 |
|
|
sl@0
|
228 |
/**
|
|
sl@0
|
229 |
* @brief Set the target area where the Image Source should appear.
|
|
sl@0
|
230 |
*
|
|
sl@0
|
231 |
* Set the target area in the target screen (or off-screen buffer)
|
|
sl@0
|
232 |
* where the Image Source should appear. Scaling may result if
|
|
sl@0
|
233 |
* the source and destination rectangles differ. A platform specific
|
|
sl@0
|
234 |
* algorithm will be used to interpolate the scaled image.
|
|
sl@0
|
235 |
*
|
|
sl@0
|
236 |
* @param aDest The destination rectangle in the target.
|
|
sl@0
|
237 |
* @pre An Image Source must have been connected; @see ConnectSurface()
|
|
sl@0
|
238 |
* @return One of the system-wide error codes.
|
|
sl@0
|
239 |
* KErrGeneral, if there is no image source connected.
|
|
sl@0
|
240 |
* KErrArgument, if the destination rectangle has negative width or
|
|
sl@0
|
241 |
* height.
|
|
sl@0
|
242 |
* KErrNone, if successful.
|
|
sl@0
|
243 |
*/
|
|
sl@0
|
244 |
virtual TInt SetDestinationRectangle(const TRect& aDest) = 0;
|
|
sl@0
|
245 |
|
|
sl@0
|
246 |
/**
|
|
sl@0
|
247 |
* @brief Get the target area where the Image Source would appear.
|
|
sl@0
|
248 |
*
|
|
sl@0
|
249 |
* Get the target area where the Image Source would appear. The default
|
|
sl@0
|
250 |
* value is at (0,0) sized to the Image Source clipped to the size
|
|
sl@0
|
251 |
* of the target.
|
|
sl@0
|
252 |
*
|
|
sl@0
|
253 |
* @param aDest The destination rectangle is updated with the current
|
|
sl@0
|
254 |
* region used in the target screen.
|
|
sl@0
|
255 |
* @pre An Image Source must have been connected; @see ConnectSurface()
|
|
sl@0
|
256 |
* @return One of the system-wide error codes.
|
|
sl@0
|
257 |
* KErrGeneral, if no Image Source has been connected.
|
|
sl@0
|
258 |
* KErrNone, if successful.
|
|
sl@0
|
259 |
*/
|
|
sl@0
|
260 |
virtual TInt GetDestinationRectangle(TRect& aDest) const = 0;
|
|
sl@0
|
261 |
|
|
sl@0
|
262 |
/**
|
|
sl@0
|
263 |
* @brief Clip the target area where the Image Source would appear.
|
|
sl@0
|
264 |
*
|
|
sl@0
|
265 |
* Set clipping area where the Image Source would appear. The default
|
|
sl@0
|
266 |
* value is the area of the target screen.
|
|
sl@0
|
267 |
*
|
|
sl@0
|
268 |
* @param aDestClipRect The clipping rectangle in the target. (0,0,0,0)
|
|
sl@0
|
269 |
* means the entire size of the Target Screen.
|
|
sl@0
|
270 |
* @return One of the system-wide error codes.
|
|
sl@0
|
271 |
* KErrGeneral, if no Image Source has been connected.
|
|
sl@0
|
272 |
* KErrArgument, if the rectangle has negative width or height
|
|
sl@0
|
273 |
* KErrNone, if successful.
|
|
sl@0
|
274 |
*/
|
|
sl@0
|
275 |
virtual TInt SetDestinationClippingRect(const TRect& aDestClipRect) = 0;
|
|
sl@0
|
276 |
|
|
sl@0
|
277 |
/**
|
|
sl@0
|
278 |
* @brief Get the clipping area in the target.
|
|
sl@0
|
279 |
*
|
|
sl@0
|
280 |
* Get the clipping area which limits where in the target screen the
|
|
sl@0
|
281 |
* element may appear.
|
|
sl@0
|
282 |
*
|
|
sl@0
|
283 |
* @param aDestClipRect The clipping rectangle is updated with the current
|
|
sl@0
|
284 |
* clipping area used in the target screen.
|
|
sl@0
|
285 |
* @return One of the system-wide error codes. KErrGeneral means no Image
|
|
sl@0
|
286 |
* Source has been connected. KErrNone is returned upon success.
|
|
sl@0
|
287 |
*/
|
|
sl@0
|
288 |
virtual TInt GetDestinationClippingRect(TRect& aDestClipRect) const = 0;
|
|
sl@0
|
289 |
|
|
sl@0
|
290 |
/**
|
|
sl@0
|
291 |
* @brief Set the rotation that should appear in the target for the
|
|
sl@0
|
292 |
* Image Source.
|
|
sl@0
|
293 |
*
|
|
sl@0
|
294 |
* Set the rotation which describes how the connected Image Source
|
|
sl@0
|
295 |
* should be rotated to appear in the target.
|
|
sl@0
|
296 |
*
|
|
sl@0
|
297 |
* @param aElementRotation The amount of rotation in the target.
|
|
sl@0
|
298 |
* @pre An Image Source must have been connected; @see ConnectSurface()
|
|
sl@0
|
299 |
* @return One of the system-wide error codes.
|
|
sl@0
|
300 |
* KErrGeneral, if no Image Source has been connected.
|
|
sl@0
|
301 |
* KErrArgument, if an out of bounds rotation value has been
|
|
sl@0
|
302 |
* supplied.
|
|
sl@0
|
303 |
* KErrNone, if successful.
|
|
sl@0
|
304 |
*/
|
|
sl@0
|
305 |
virtual TInt SetSourceRotation(const TElementRotation aElementRotation) = 0;
|
|
sl@0
|
306 |
|
|
sl@0
|
307 |
/**
|
|
sl@0
|
308 |
* @brief Get the pending rotation setting as it would appear in the target.
|
|
sl@0
|
309 |
*
|
|
sl@0
|
310 |
* Get the pending rotation setting for the connected Image Source.
|
|
sl@0
|
311 |
* By default, the rotation is EElementAntiClockwise0 and this is returned
|
|
sl@0
|
312 |
* if there is no connected Image Source.
|
|
sl@0
|
313 |
*
|
|
sl@0
|
314 |
* @return The pending rotation setting.
|
|
sl@0
|
315 |
*/
|
|
sl@0
|
316 |
virtual TElementRotation SourceRotation() const = 0 ;
|
|
sl@0
|
317 |
|
|
sl@0
|
318 |
/**
|
|
sl@0
|
319 |
* @brief Set flipping about the image horizontal centerline.
|
|
sl@0
|
320 |
*
|
|
sl@0
|
321 |
* Set the pending flipping setting for the connected Image Source.
|
|
sl@0
|
322 |
* When flipped, the Image Source appears in the target as inverted
|
|
sl@0
|
323 |
* about its horizontal centerline. This effect can be combined
|
|
sl@0
|
324 |
* with rotation effects.
|
|
sl@0
|
325 |
* By default, the Image Source is not flipped.
|
|
sl@0
|
326 |
*
|
|
sl@0
|
327 |
* @param aFlip If ETrue, the connected Image is flipped, else
|
|
sl@0
|
328 |
* it is not flipped.
|
|
sl@0
|
329 |
* @pre An Image Source must have been connected; @see ConnectSurface()
|
|
sl@0
|
330 |
* @return One of the system-wide error codes.
|
|
sl@0
|
331 |
* KErrGeneral, if no Image Source has been connceted.
|
|
sl@0
|
332 |
* KErrNotSupported, if the platform does not support the feature.
|
|
sl@0
|
333 |
* KErrNone, if successful.
|
|
sl@0
|
334 |
*/
|
|
sl@0
|
335 |
virtual TInt SetSourceFlipping(const TBool aFlip) = 0;
|
|
sl@0
|
336 |
|
|
sl@0
|
337 |
/**
|
|
sl@0
|
338 |
* @brief Get the pending flipping setting.
|
|
sl@0
|
339 |
*
|
|
sl@0
|
340 |
* Get the pending flipping setting for the connected Image Source.
|
|
sl@0
|
341 |
* By default, the image is not flipped.
|
|
sl@0
|
342 |
*
|
|
sl@0
|
343 |
* @return The pending flipping setting. If no Image is connected, return
|
|
sl@0
|
344 |
* EFalse.
|
|
sl@0
|
345 |
*/
|
|
sl@0
|
346 |
virtual TBool SourceFlipping() const = 0 ;
|
|
sl@0
|
347 |
|
|
sl@0
|
348 |
/**
|
|
sl@0
|
349 |
* @brief Set Target Renderer Flags associated with this Element
|
|
sl@0
|
350 |
*
|
|
sl@0
|
351 |
* Set the Target Renderer flags to be associated with this Element.
|
|
sl@0
|
352 |
*
|
|
sl@0
|
353 |
* @note Flags which are not recognised by an implementation must
|
|
sl@0
|
354 |
* be kept to allow the interface to be extended in a
|
|
sl@0
|
355 |
* compatible manner.
|
|
sl@0
|
356 |
* @param aTargetRendererFlags Flags to set for Target Renderer;
|
|
sl@0
|
357 |
* @see TElementTargetRendererFlags
|
|
sl@0
|
358 |
* @return One of the system-wide error codes.
|
|
sl@0
|
359 |
* KErrNotSupported, if the platform does not support the given
|
|
sl@0
|
360 |
* flags.
|
|
sl@0
|
361 |
* KErrArgument, if incompatible flag settings have been made.
|
|
sl@0
|
362 |
* KErrNone, if successful.
|
|
sl@0
|
363 |
*/
|
|
sl@0
|
364 |
virtual TInt SetTargetRendererFlags(const TUint32& aTargetRendererFlags) = 0;
|
|
sl@0
|
365 |
|
|
sl@0
|
366 |
/**
|
|
sl@0
|
367 |
* @brief Set Render Stage Flags associated with this Element
|
|
sl@0
|
368 |
*
|
|
sl@0
|
369 |
* Set the Render Stage flags to be associated with this Element.
|
|
sl@0
|
370 |
*
|
|
sl@0
|
371 |
* @note Flags which are not recognised by an implementation must
|
|
sl@0
|
372 |
* be kept to allow the interface to be extended in a
|
|
sl@0
|
373 |
* compatible manner.
|
|
sl@0
|
374 |
* @param aRenderStageFlags Flags to set for Render Stage Plug-ins;
|
|
sl@0
|
375 |
* @see TElementRenderStageFlags
|
|
sl@0
|
376 |
* @return One of the system-wide error codes.
|
|
sl@0
|
377 |
* KErrNotSupported, if the platform does not support the given
|
|
sl@0
|
378 |
* flags.
|
|
sl@0
|
379 |
* KErrArgument, if incompatible flag settings have been requested.
|
|
sl@0
|
380 |
* KErrNone, if successful.
|
|
sl@0
|
381 |
*/
|
|
sl@0
|
382 |
virtual TInt SetRenderStageFlags(const TUint32& aRenderStageFlags) = 0;
|
|
sl@0
|
383 |
|
|
sl@0
|
384 |
/**
|
|
sl@0
|
385 |
* @brief Get Target Renderer Flags associated with this Element
|
|
sl@0
|
386 |
*
|
|
sl@0
|
387 |
* Get the Target Renderer flags associated with this Element.
|
|
sl@0
|
388 |
*
|
|
sl@0
|
389 |
* @note Flags which are not recognised by an implementation must
|
|
sl@0
|
390 |
* be kept to allow the interface to be extended in a
|
|
sl@0
|
391 |
* compatible manner.
|
|
sl@0
|
392 |
* @param aTargetRendererFlags Variable to receive TElementTargetRendererFlags
|
|
sl@0
|
393 |
*/
|
|
sl@0
|
394 |
virtual void GetTargetRendererFlags(TUint32& aTargetRendererFlags) const = 0;
|
|
sl@0
|
395 |
|
|
sl@0
|
396 |
/**
|
|
sl@0
|
397 |
* @brief Get Render Stage Flags associated with this Element
|
|
sl@0
|
398 |
*
|
|
sl@0
|
399 |
* Get the Render Stage flags associated with this Element.
|
|
sl@0
|
400 |
*
|
|
sl@0
|
401 |
* @note Flags which are not recognised by an implementation must
|
|
sl@0
|
402 |
* be kept to allow the interface to be extended in a
|
|
sl@0
|
403 |
* compatible manner.
|
|
sl@0
|
404 |
* @param aRenderStageFlags Variable to receive TElementRenderStageFlags
|
|
sl@0
|
405 |
*/
|
|
sl@0
|
406 |
virtual void GetRenderStageFlags(TUint32& aRenderStageFlags) const = 0;
|
|
sl@0
|
407 |
|
|
sl@0
|
408 |
/**
|
|
sl@0
|
409 |
* @brief Get the Element above this Element.
|
|
sl@0
|
410 |
*
|
|
sl@0
|
411 |
* Get the Element which is above this Element in the Pending Scene.
|
|
sl@0
|
412 |
* If the Element is the top-most element, NULL is returned. If the
|
|
sl@0
|
413 |
* Element is not in the Scene, NULL is returned.
|
|
sl@0
|
414 |
*
|
|
sl@0
|
415 |
* @return Element above, or NULL.
|
|
sl@0
|
416 |
*/
|
|
sl@0
|
417 |
virtual MWsElement *ElementAbove() = 0;
|
|
sl@0
|
418 |
|
|
sl@0
|
419 |
/**
|
|
sl@0
|
420 |
* @brief Get the Element below this Element.
|
|
sl@0
|
421 |
*
|
|
sl@0
|
422 |
* Get the Element which is below this Element in the Pending Scene.
|
|
sl@0
|
423 |
* If the Element is the bottom-most element, NULL is returned. If the
|
|
sl@0
|
424 |
* Element is not in the Scene, NULL is returned.
|
|
sl@0
|
425 |
*
|
|
sl@0
|
426 |
* @return Element below, or NULL.
|
|
sl@0
|
427 |
*/
|
|
sl@0
|
428 |
virtual MWsElement *ElementBelow() = 0;
|
|
sl@0
|
429 |
|
|
sl@0
|
430 |
/**
|
|
sl@0
|
431 |
* @brief Connect or re-Connect a Surface to this Element.
|
|
sl@0
|
432 |
*
|
|
sl@0
|
433 |
* Connect the given Surface to this Element, or re-Connect a new
|
|
sl@0
|
434 |
* Surface to this Element which already has a connected Surface.
|
|
sl@0
|
435 |
* The Element does not need to be in the Scene when this call is made.
|
|
sl@0
|
436 |
*
|
|
sl@0
|
437 |
* @note The Source Rectangle of the Element is updated to correspond
|
|
sl@0
|
438 |
* to match the Source Rectangle of the Surface. Thus any
|
|
sl@0
|
439 |
* prior Source Rectangle setting will be overwritten.
|
|
sl@0
|
440 |
*
|
|
sl@0
|
441 |
* @param aSurface Surface to connect to. If this is the Null
|
|
sl@0
|
442 |
* Surface, then the Source Rectangle of the
|
|
sl@0
|
443 |
* Element is set to (0,0,0,0).
|
|
sl@0
|
444 |
* @return One of the system-wide error codes.
|
|
sl@0
|
445 |
* KErrArgument, if supplied Surface cannot be connected. For
|
|
sl@0
|
446 |
* example the Element has a flag indicating it has an Alpha
|
|
sl@0
|
447 |
* Channel but the Surface does not.
|
|
sl@0
|
448 |
* KErrNone, if successful.
|
|
sl@0
|
449 |
*/
|
|
sl@0
|
450 |
virtual TInt ConnectSurface(const TSurfaceId& aSurface) = 0;
|
|
sl@0
|
451 |
|
|
sl@0
|
452 |
/**
|
|
sl@0
|
453 |
* @brief Get the Surface connected to this Element
|
|
sl@0
|
454 |
*
|
|
sl@0
|
455 |
* @return The Surface Identifier of the Connected Surface. This
|
|
sl@0
|
456 |
* identifier may represent the Null Surface Id if there
|
|
sl@0
|
457 |
* was no Surface connected in the Pending Scene for this
|
|
sl@0
|
458 |
* Element.
|
|
sl@0
|
459 |
*/
|
|
sl@0
|
460 |
virtual const TSurfaceId& ConnectedSurface() const = 0;
|
|
sl@0
|
461 |
|
|
sl@0
|
462 |
/**
|
|
sl@0
|
463 |
* @brief Set the Global Alpha Transparency value
|
|
sl@0
|
464 |
*
|
|
sl@0
|
465 |
* Sets the Global Alpha Transparency value for this Element. Elements
|
|
sl@0
|
466 |
* are by default fully opaque, represented by opacity 255. On platforms
|
|
sl@0
|
467 |
* that support it, the Alpha Transparency value can be reduced down
|
|
sl@0
|
468 |
* to 0 representing fully transparent. The purpose of this is to
|
|
sl@0
|
469 |
* allow the fading in and fading out of Elements into the Scene.
|
|
sl@0
|
470 |
*
|
|
sl@0
|
471 |
* @param aAlpha The Alpha Transparency value desired. Values
|
|
sl@0
|
472 |
* are clamped to be within the range [0, 255] where 0
|
|
sl@0
|
473 |
* represents fully transparent, and 255 represents
|
|
sl@0
|
474 |
* fully opaque.
|
|
sl@0
|
475 |
* @note This setting has no effect unless the flag
|
|
sl@0
|
476 |
* Target Renderer flag EElementTransparencyGlobalAlpha
|
|
sl@0
|
477 |
* is set; @see SetTargetRendererFlags()
|
|
sl@0
|
478 |
* @note Out of range values are clamped silently, and do not cause
|
|
sl@0
|
479 |
* error conditions.
|
|
sl@0
|
480 |
* @return One of the system-wide error codes.
|
|
sl@0
|
481 |
* KErrNotSupported, if the supplied value, once clamped, is not
|
|
sl@0
|
482 |
* supported on the platform.
|
|
sl@0
|
483 |
* KErrNone, if successful.
|
|
sl@0
|
484 |
*/
|
|
sl@0
|
485 |
virtual TInt SetGlobalAlpha(const TInt aAlpha) = 0;
|
|
sl@0
|
486 |
|
|
sl@0
|
487 |
/**
|
|
sl@0
|
488 |
* @brief Get the Global Alpha Transparency value
|
|
sl@0
|
489 |
*
|
|
sl@0
|
490 |
* Gets the Global Alpha Transparency value for this Element. Elements
|
|
sl@0
|
491 |
* are by default fully opaque, represented by opacity 255.
|
|
sl@0
|
492 |
*
|
|
sl@0
|
493 |
* @param aAlpha Variable which receives the Global Alpha Transparency
|
|
sl@0
|
494 |
* value.
|
|
sl@0
|
495 |
*/
|
|
sl@0
|
496 |
virtual void GlobalAlpha(TInt& aAlpha) const = 0;
|
|
sl@0
|
497 |
};
|
|
sl@0
|
498 |
#endif // WSELEMENT_H
|