summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/rendering/XVolatileBitmap.idl
blob: 2597243f5505042ae41cf2522d545153dc2bd4e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_rendering_XVolatileBitmap_idl__
#define __com_sun_star_rendering_XVolatileBitmap_idl__

#ifndef __com_sun_star_rendering_XBitmap_idl__
#include <com/sun/star/rendering/XBitmap.idl>
#endif

module com { module sun { module star { module rendering {

/** This is a specialized interface to a volatile bitmap (which can
    become invalid at any point in time).
 */
interface XVolatileBitmap : XBitmap
{
    /** Query whether this volatile bitmap still has valid content.

        As the video RAM allocated to this bitmap can be reclaimed at
        any time, a return value of true here does not imply that the
        next draw operation with this bitmap will succeed. Instead,
        the exception VolatileContentDestroyed might then be thrown,
        if lost bitmap data is accessed.
     */
    boolean isValid();
};

}; }; }; };

#endif