1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_rendering_XCustomSprite_idl__
24#define __com_sun_star_rendering_XCustomSprite_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29#ifndef __com_sun_star_rendering_ViewState_idl__
30#include <com/sun/star/rendering/ViewState.idl>
31#endif
32#ifndef __com_sun_star_rendering_RenderState_idl__
33#include <com/sun/star/rendering/RenderState.idl>
34#endif
35#ifndef __com_sun_star_rendering_XSprite_idl__
36#include <com/sun/star/rendering/XSprite.idl>
37#endif
38
39module com { module sun { module star { module rendering {
40
41published interface XCanvas;
42
43/** Interface to control a custom sprite object on a XSpriteCanvas.<p>
44
45    Every change performed on XCustomSprite objects is only visible
46    after a XSpriteCanvas::updateScreen() call, to facilitate
47    synchronized screen updates.
48
49    TODO: Maybe more than alpha has to be overridden from render state.
50    TODO: Provide means to change the output area
51 */
52published interface XCustomSprite : XSprite
53{
54
55    /** Query a render canvas for this sprite's content.<p>
56
57        Whatever is rendered to this canvas will become visible on the
58        screen only after a XSpriteCanvas::updateScreen() call at the
59        associated sprite canvas. This canvas is not equivalent to the
60        host canvas of the sprite. At the very least, all output
61        happens relative to the sprite's upper left corner, i.e. the
62        origin of the sprite's canvas device coordinate system will
63        move with the sprite across the screen.
64
65        @return the canvas the sprite content can be rendered into.
66     */
67    XCanvas getContentCanvas();
68
69};
70
71}; }; }; };
72
73#endif
74