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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_rendering_XBitmap_idl__
  28 #define __com_sun_star_rendering_XBitmap_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #endif
  36 #ifndef __com_sun_star_geometry_IntegerSize2D_idl__
  37 #include <com/sun/star/geometry/IntegerSize2D.idl>
  38 #endif
  39 #ifndef __com_sun_star_geometry_RealSize2D_idl__
  40 #include <com/sun/star/geometry/RealSize2D.idl>
  41 #endif
  42 #ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__
  43 #include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
  44 #endif
  45
  46 module com { module sun { module star { module rendering {
  47
  48 interface XBitmapCanvas;
  49
  50 /** This is a generic interface to a bitmap.<p>
  51
  52     This interface contains the generic functionality to be used on
  53     every <type>XCanvas</type> bitmap object. More format-specific
  54     methods can be found at the <type>XIntegerBitmap</type>,
  55     <type>XIeeeDoubleBitmap</type>, <type>XIeeeFloatBitmap</type> and
  56     <type>XHalfFloatBitmap</type> interfaces.<p>
  57
  58     @since OOo 2.0.0
  59  */
  60 interface XBitmap : ::com::sun::star::uno::XInterface
  61 {
  62     /** Query the size of the bitmap.<p>
  63
  64         This method queries the bitmap size in pixel.<p>
  65
  66         @return the bitmap size in pixel.
  67       */
  68     ::com::sun::star::geometry::IntegerSize2D   getSize();
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** Query transparency status of the bitmap.<p>
  73
  74         The method checks, whether the bitmap contains any alpha
  75         information. The same information is also available at the
  76         <type>XColorSpace</type> associated with this bitmap, though
  77         much easier to access here (the color space then has a
  78         component flagged
  79         <member>ColorComponentTag::ALPHA</member>).<p>
  80
  81         @return <TRUE/>, if the bitmap has alpha data, or <FALSE/> if
  82         not.
  83       */
  84     boolean                                     hasAlpha();
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** Query a scaled copy of the original bitmap.
  89
  90         @param newSize
  91         Requested size of the new bitmap. Both of the two size
  92         components must be greater than zero.
  93
  94         @param beFast
  95         When set to true, this parameter advises getScaledBitmap to
  96         use the fastest available algorithm to scale the bitmap, which
  97         might cause visible artifacts.
  98
  99         @returns the new scaled bitmap.
 100
 101         @throws <type>com::sun::star::lang::IllegalArgumentException</type>
 102         if the size components are outside the specified range.
 103
 104         @throws <type>VolatileContentDestroyedException</type>
 105         if the contents of a volatile bitmap have been destroyed, and
 106         thus cannot be read to generate the scaled bitmap.
 107      */
 108     XBitmap                         getScaledBitmap( [in] ::com::sun::star::geometry::RealSize2D newSize, [in] boolean beFast )
 109         raises (com::sun::star::lang::IllegalArgumentException,
 110                 VolatileContentDestroyedException);
 111 };
 112
 113 }; }; }; };
 114
 115 #endif