summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/rendering/XVolatileBitmap.idl
blob: 7924ccf1f771803c20aa76a1737c7c8f1370c1b1 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_rendering_XVolatileBitmap_idl__
#define __com_sun_star_rendering_XVolatileBitmap_idl__

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

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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */