blob: 675e5d97ce859e3100b15d2e82753f44c84c35da (
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
* 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_util_XLockable_idl__
#define __com_sun_star_util_XLockable_idl__
#include <com/sun/star/util/NotLockedException.idl>
//==================================================================================================================
module com { module sun { module star { module util {
//==================================================================================================================
/** allows locking a component
<p><code>lock</code> and <code>unlock</code> calls can be nested. However, they must be in
pairs. As long as there has been one more call to <code>lock</code> than to <code>unlock</code>, the
component is considered locked, which is reflected by <member>isLocked</member> returning <TRUE/>.</p>
*/
interface XLockable
{
/** locks</a> the component
@see unlock
@see isLocked
*/
void lock();
/** unlocks the component
@throws NotLockedException
if the component is not currently locked.
@see lock
@see isLocked
*/
void unlock()
raises ( NotLockedException
);
/** determines whether the component is currently locked.
@see lock
@see unlock
*/
boolean isLocked();
};
//==================================================================================================================
}; }; }; };
//==================================================================================================================
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
