offapi/com/sun/star/rendering/XBitmapCanvas.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_XBitmapCanvas_idl__
  20 #define __com_sun_star_rendering_XBitmapCanvas_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/geometry/RealRectangle2D.idl>
  25 #include <com/sun/star/rendering/RenderState.idl>
  26 #include <com/sun/star/rendering/XCanvas.idl>
  27 #include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
  28
  29
  30 module com { module sun { module star { module rendering {
  31
  32 /** This is a specialization of the canvas interface for bitmapped
  33     canvases.<p>
  34
  35     This interface is a specialization of the canvas interface for
  36     bitmapped canvases, where additional methods for accessing and
  37     moving of bitmap content are provided.<p>
  38
  39     @since OOo 2.0
  40  */
  41 interface XBitmapCanvas : XCanvas
  42 {
  43     /** This method copies a rectangular area from a place of one
  44         canvas to a place on another.<p>
  45
  46         This method copies a rectangular area from a place of one
  47         canvas to a place on another. Source and destination areas are
  48         permitted to overlap. If the source view or render state has a
  49         clipping set, the regions clipped away from the source
  50         rectangle are regarded fully transparent for the copy
  51         operation. The device color for both source and destination
  52         render state is ignored, the compositing mode only for the
  53         source render state.<p>
  54
  55         @param sourceCanvas
  56         Canvas from which to copy the bitmap data. Can be identical to
  57         the canvas this method is called on, but must be valid.
  58
  59         @param sourceRect
  60         Rectangle from which to copy the bitmap data. This rectangle
  61         is subject to both view and render transformation, before
  62         being applied. Thus, on screen, it does not necessarily
  63         resemble a rectangle any more. The rectangle must be
  64         non-empty, see
  65         ::com::sun::star::geometry::RealRectangle2D
  66         for details.
  67
  68         @param sourceViewState
  69         The view state to apply to the source of this copy
  70         operation. The view transformation must be non-singular.
  71
  72         @param sourceRenderState
  73         The render state to apply to the source of this copy
  74         operation. The render transformation must be non-singular, and
  75         the compositing mode must be one of the
  76         CompositingOperation values.
  77
  78         @param destRect
  79         Rectangle into which to copy the bitmap data. This rectangle
  80         is subject to both view and render transformation, before
  81         being applied. Thus, on screen, it does not necessarily
  82         resemble a rectangle any more. The rectangle must be
  83         non-empty, see
  84         ::com::sun::star::geometry::RealRectangle2D
  85         for details.
  86
  87         @param destViewState
  88         The view state to apply to the destination of this copy
  89         operation. The view transformation must be non-singular.
  90
  91         @param destRenderState
  92
  93         The render state to apply to the destination of this copy
  94         operation. The render transformation must be non-singular, and
  95         the compositing mode must be one of the
  96         CompositingOperation values.
  97
  98         @throws com::sun::star::lang::IllegalArgumentException
  99         if one of the parameters are not within the specified range.
 100      */
 101     void copyRect( [in] XBitmapCanvas sourceCanvas,
 102                    [in] ::com::sun::star::geometry::RealRectangle2D sourceRect, [in] ViewState sourceViewState, [in] RenderState sourceRenderState,
 103                    [in] ::com::sun::star::geometry::RealRectangle2D destRect, [in] ViewState destViewState, [in] RenderState destRenderState )
 104         raises (com::sun::star::lang::IllegalArgumentException,
 105                 VolatileContentDestroyedException);
 106
 107 };
 108
 109 }; }; }; };
 110
 111 #endif
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */