offapi/com/sun/star/rendering/XVolatileBitmap.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_XVolatileBitmap_idl__
  20 #define __com_sun_star_rendering_XVolatileBitmap_idl__
  21
  22 #include <com/sun/star/rendering/XBitmap.idl>
  23
  24 module com { module sun { module star { module rendering {
  25
  26 /** This is a specialized interface to a volatile bitmap (which can
  27     become invalid at any point in time).
  28  */
  29 interface XVolatileBitmap : XBitmap
  30 {
  31     /** Query whether this volatile bitmap still has valid content.
  32
  33         As the video RAM allocated to this bitmap can be reclaimed at
  34         any time, a return value of true here does not imply that the
  35         next draw operation with this bitmap will succeed. Instead,
  36         the exception VolatileContentDestroyed might then be thrown,
  37         if lost bitmap data is accessed.
  38      */
  39     boolean isValid();
  40 };
  41
  42 }; }; }; };
  43
  44 #endif
  45
  46 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */