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_util_XModifiable2_idl__
28#define __com_sun_star_util_XModifiable2_idl__
29
30#ifndef __com_sun_star_util_XModifiable_idl__
31#include <com/sun/star/util/XModifiable.idl>
32#endif
33
34#ifndef __com_sun_star_beans_PropertyVetoException_idl__
35#include <com/sun/star/beans/PropertyVetoException.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module util {
42
43//=============================================================================
44
45/** allows to control modifiable state change.
46
47    <p>
48    This interface allows to prevent changing of the modified state of the
49    object. It is introduced for performance optimizations, to allow to prevent
50    unnecessary updates, for example while importing a document.
51    Please use this interface very carefuly.
52    </p>
53 */
54published interface XModifiable2: com::sun::star::util::XModifiable
55{
56    //-------------------------------------------------------------------------
57    /** disable possibility to change modified state of the document
58
59        @retuns the value that says whether the modified state change was
60                enabled before the call
61            <TRUE/> the changing of the modified state was already disabled
62            <FALSE/> the changing of the modified state was enabled
63
64     */
65    boolean disableSetModified();
66
67    //-------------------------------------------------------------------------
68    /** enable possibility to change modified state of the document
69
70        @retuns the value that says whether the modified state change was
71                enabled before the call
72            <TRUE/> the changing of the modified state was disabled
73            <FALSE/> the changing of the modified state was already enabled
74     */
75    boolean enableSetModified();
76
77    //-------------------------------------------------------------------------
78    /** allows to detect whether the modified state change is enabled
79     */
80    boolean isSetModifiedEnabled();
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88
89