1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_document_XActionLockable_idl__
28#define __com_sun_star_document_XActionLockable_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37module com {   module sun {   module star {   module document {
38
39//=============================================================================
40
41/** makes it possible to prevent object internal updates for a certain period
42	to be able to quickly change multiple parts of the objects, where the
43	updates would invalidate each other, anyway.
44 */
45published interface XActionLockable: com::sun::star::uno::XInterface
46{
47	//-------------------------------------------------------------------------
48	/** @returns
49			<TRUE/> if at least one lock exists.
50	 */
51	boolean isActionLocked();
52
53	//-------------------------------------------------------------------------
54	/** increments the lock count of the object by one.
55	 */
56	void addActionLock();
57
58	//-------------------------------------------------------------------------
59	/** decrements the lock count of the object by one.
60	 */
61	void removeActionLock();
62
63	//-------------------------------------------------------------------------
64	/** sets the locking level.
65
66		<p>This method is used for debugging purposes. The programming
67		environment can restore the locking after a break of a debug
68		session.</p>
69	 */
70	void setActionLocks( [in] short nLock );
71
72	//-------------------------------------------------------------------------
73	/** resets the locking level.
74
75		<p>This method is used for debugging purposes. The debugging
76		environment of a programming language can reset the locks
77		to allow refreshing of the view if a breakpoint is reached or
78		step execution is used. </p>
79	 */
80	short resetActionLocks();
81
82};
83
84//=============================================================================
85
86}; }; }; };
87
88#endif
89