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