1d1766043SAndrew Rist/************************************************************** 2d1766043SAndrew Rist * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XBitmap_idl__ 24cdf0e10cSrcweir#define __com_sun_star_rendering_XBitmap_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_lang_IllegalArgumentException_idl__ 30cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 31cdf0e10cSrcweir#endif 32cdf0e10cSrcweir#ifndef __com_sun_star_geometry_IntegerSize2D_idl__ 33cdf0e10cSrcweir#include <com/sun/star/geometry/IntegerSize2D.idl> 34cdf0e10cSrcweir#endif 35cdf0e10cSrcweir#ifndef __com_sun_star_geometry_RealSize2D_idl__ 36cdf0e10cSrcweir#include <com/sun/star/geometry/RealSize2D.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir#ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/rendering/VolatileContentDestroyedException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweirmodule com { module sun { module star { module rendering { 43cdf0e10cSrcweir 44cdf0e10cSrcweir/** This is a generic interface to a bitmap.<p> 45cdf0e10cSrcweir 46cdf0e10cSrcweir This interface contains the generic functionality to be used on 47cdf0e10cSrcweir every <type>XCanvas</type> bitmap object. More format-specific 48cdf0e10cSrcweir methods can be found at the <type>XIntegerBitmap</type>, 49cdf0e10cSrcweir <type>XIeeeDoubleBitmap</type>, <type>XIeeeFloatBitmap</type> and 50cdf0e10cSrcweir <type>XHalfFloatBitmap</type> interfaces.<p> 51cdf0e10cSrcweir 52*d695a2a0SJürgen Schmidt @since OpenOffice 2.0 53cdf0e10cSrcweir */ 54cdf0e10cSrcweirpublished interface XBitmap : ::com::sun::star::uno::XInterface 55cdf0e10cSrcweir{ 56cdf0e10cSrcweir /** Query the size of the bitmap.<p> 57cdf0e10cSrcweir 58cdf0e10cSrcweir This method queries the bitmap size in pixel.<p> 59cdf0e10cSrcweir 60cdf0e10cSrcweir @return the bitmap size in pixel. 61cdf0e10cSrcweir */ 62cdf0e10cSrcweir ::com::sun::star::geometry::IntegerSize2D getSize(); 63cdf0e10cSrcweir 64cdf0e10cSrcweir //------------------------------------------------------------------------- 65cdf0e10cSrcweir 66cdf0e10cSrcweir /** Query transparency status of the bitmap.<p> 67cdf0e10cSrcweir 68cdf0e10cSrcweir The method checks, whether the bitmap contains any alpha 69cdf0e10cSrcweir information. The same information is also available at the 70cdf0e10cSrcweir <type>XColorSpace</type> associated with this bitmap, though 71cdf0e10cSrcweir much easier to access here (the color space then has a 72cdf0e10cSrcweir component flagged 73cdf0e10cSrcweir <member>ColorComponentTag::ALPHA</member>).<p> 74cdf0e10cSrcweir 75cdf0e10cSrcweir @return <TRUE/>, if the bitmap has alpha data, or <FALSE/> if 76cdf0e10cSrcweir not. 77cdf0e10cSrcweir */ 78cdf0e10cSrcweir boolean hasAlpha(); 79cdf0e10cSrcweir 80cdf0e10cSrcweir //------------------------------------------------------------------------- 81cdf0e10cSrcweir 82cdf0e10cSrcweir /** Query a scaled copy of the original bitmap. 83cdf0e10cSrcweir 84cdf0e10cSrcweir @param newSize 85cdf0e10cSrcweir Requested size of the new bitmap. Both of the two size 86cdf0e10cSrcweir components must be greater than zero. 87cdf0e10cSrcweir 88cdf0e10cSrcweir @param beFast 89cdf0e10cSrcweir When set to true, this parameter advises getScaledBitmap to 90cdf0e10cSrcweir use the fastest available algorithm to scale the bitmap, which 91cdf0e10cSrcweir might cause visible artifacts. 92cdf0e10cSrcweir 93cdf0e10cSrcweir @returns the new scaled bitmap. 94cdf0e10cSrcweir 95cdf0e10cSrcweir @throws <type>com::sun::star::lang::IllegalArgumentException</type> 96cdf0e10cSrcweir if the size components are outside the specified range. 97cdf0e10cSrcweir 98cdf0e10cSrcweir @throws <type>VolatileContentDestroyedException</type> 99cdf0e10cSrcweir if the contents of a volatile bitmap have been destroyed, and 100cdf0e10cSrcweir thus cannot be read to generate the scaled bitmap. 101cdf0e10cSrcweir */ 102cdf0e10cSrcweir XBitmap getScaledBitmap( [in] ::com::sun::star::geometry::RealSize2D newSize, [in] boolean beFast ) 103cdf0e10cSrcweir raises (com::sun::star::lang::IllegalArgumentException, 104cdf0e10cSrcweir VolatileContentDestroyedException); 105cdf0e10cSrcweir}; 106cdf0e10cSrcweir 107cdf0e10cSrcweir}; }; }; }; 108cdf0e10cSrcweir 109cdf0e10cSrcweir#endif 110