offapi/com/sun/star/rendering/XCustomSprite.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XCustomSprite.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_rendering_XCustomSprite_idl__
  31 #define __com_sun_star_rendering_XCustomSprite_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_rendering_ViewState_idl__
  37 #include <com/sun/star/rendering/ViewState.idl>
  38 #endif
  39 #ifndef __com_sun_star_rendering_RenderState_idl__
  40 #include <com/sun/star/rendering/RenderState.idl>
  41 #endif
  42 #ifndef __com_sun_star_rendering_XSprite_idl__
  43 #include <com/sun/star/rendering/XSprite.idl>
  44 #endif
  45
  46 module com { module sun { module star { module rendering {
  47
  48 interface XCanvas;
  49
  50 /** Interface to control a custom sprite object on a XSpriteCanvas.<p>
  51
  52     Every change performed on XCustomSprite objects is only visible
  53     after a XSpriteCanvas::updateScreen() call, to facilitate
  54     synchronized screen updates.
  55
  56     TODO: Maybe more than alpha has to be overridden from render state.
  57     TODO: Provide means to change the output area
  58  */
  59 interface XCustomSprite : XSprite
  60 {
  61
  62     /** Query a render canvas for this sprite's content.<p>
  63
  64         Whatever is rendered to this canvas will become visible on the
  65         screen only after a XSpriteCanvas::updateScreen() call at the
  66         associated sprite canvas. This canvas is not equivalent to the
  67         host canvas of the sprite. At the very least, all output
  68         happens relative to the sprite's upper left corner, i.e. the
  69         origin of the sprite's canvas device coordinate system will
  70         move with the sprite across the screen.
  71
  72         @return the canvas the sprite content can be rendered into.
  73      */
  74     XCanvas getContentCanvas();
  75
  76 };
  77
  78 }; }; }; };
  79
  80 #endif