offapi/com/sun/star/rendering/XVolatileBitmap.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: XVolatileBitmap.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_XVolatileBitmap_idl__
  31 #define __com_sun_star_rendering_XVolatileBitmap_idl__
  32
  33 #ifndef __com_sun_star_rendering_XBitmap_idl__
  34 #include <com/sun/star/rendering/XBitmap.idl>
  35 #endif
  36
  37 module com { module sun { module star { module rendering {
  38
  39 /** This is a specialized interface to a volatile bitmap (which can
  40     become invalid at any point in time).
  41  */
  42 interface XVolatileBitmap : XBitmap
  43 {
  44     /** Query whether this volatile bitmap still has valid content.
  45
  46         As the video RAM allocated to this bitmap can be reclaimed at
  47         any time, a return value of true here does not imply that the
  48         next draw operation with this bitmap will succeed. Instead,
  49         the exception VolatileContentDestroyed might then be thrown,
  50         if lost bitmap data is accessed.
  51      */
  52     boolean     isValid();
  53 };
  54
  55 }; }; }; };
  56
  57 #endif