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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_rendering_XCustomSprite_idl__
  20 #define __com_sun_star_rendering_XCustomSprite_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/rendering/ViewState.idl>
  24 #include <com/sun/star/rendering/RenderState.idl>
  25 #include <com/sun/star/rendering/XSprite.idl>
  26
  27 module com { module sun { module star { module rendering {
  28
  29 interface XCanvas;
  30
  31 /** Interface to control a custom sprite object on a XSpriteCanvas.<p>
  32
  33     Every change performed on XCustomSprite objects is only visible
  34     after a XSpriteCanvas::updateScreen() call, to facilitate
  35     synchronized screen updates.
  36
  37     TODO: Maybe more than alpha has to be overridden from render state.
  38     TODO: Provide means to change the output area
  39  */
  40 interface XCustomSprite : XSprite
  41 {
  42
  43     /** Query a render canvas for this sprite's content.<p>
  44
  45         Whatever is rendered to this canvas will become visible on the
  46         screen only after a XSpriteCanvas::updateScreen() call at the
  47         associated sprite canvas. This canvas is not equivalent to the
  48         host canvas of the sprite. At the very least, all output
  49         happens relative to the sprite's upper left corner, i.e. the
  50         origin of the sprite's canvas device coordinate system will
  51         move with the sprite across the screen.
  52
  53         @return the canvas the sprite content can be rendered into.
  54      */
  55     XCanvas getContentCanvas();
  56
  57 };
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */