xref: /trunk/main/offapi/com/sun/star/util/XModifiable2.idl (revision 33c8d0882db58659e9da530f2ab4f758fe1a9a4b)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_util_XModifiable2_idl__
24cdf0e10cSrcweir#define __com_sun_star_util_XModifiable2_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_util_XModifiable_idl__
27cdf0e10cSrcweir#include <com/sun/star/util/XModifiable.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyVetoException_idl__
31cdf0e10cSrcweir#include <com/sun/star/beans/PropertyVetoException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com {  module sun {  module star {  module util {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** allows to control modifiable state change.
42cdf0e10cSrcweir
43cdf0e10cSrcweir    <p>
44cdf0e10cSrcweir    This interface allows to prevent changing of the modified state of the
45cdf0e10cSrcweir    object. It is introduced for performance optimizations, to allow to prevent
46cdf0e10cSrcweir    unnecessary updates, for example while importing a document.
47*21947a42Smseidel    Please use this interface very carefully.
48cdf0e10cSrcweir    </p>
49cdf0e10cSrcweir */
50cdf0e10cSrcweirpublished interface XModifiable2: com::sun::star::util::XModifiable
51cdf0e10cSrcweir{
52cdf0e10cSrcweir    //-------------------------------------------------------------------------
53cdf0e10cSrcweir    /** disable possibility to change modified state of the document
54cdf0e10cSrcweir
558e0daafcSTsutomu Uchino        @returns the value that says whether the modified state change was
56cdf0e10cSrcweir                enabled before the call
57cdf0e10cSrcweir            <TRUE/> the changing of the modified state was already disabled
58cdf0e10cSrcweir            <FALSE/> the changing of the modified state was enabled
59cdf0e10cSrcweir
60cdf0e10cSrcweir     */
61cdf0e10cSrcweir    boolean disableSetModified();
62cdf0e10cSrcweir
63cdf0e10cSrcweir    //-------------------------------------------------------------------------
64cdf0e10cSrcweir    /** enable possibility to change modified state of the document
65cdf0e10cSrcweir
668e0daafcSTsutomu Uchino        @returns the value that says whether the modified state change was
67cdf0e10cSrcweir                enabled before the call
68cdf0e10cSrcweir            <TRUE/> the changing of the modified state was disabled
69cdf0e10cSrcweir            <FALSE/> the changing of the modified state was already enabled
70cdf0e10cSrcweir     */
71cdf0e10cSrcweir    boolean enableSetModified();
72cdf0e10cSrcweir
73cdf0e10cSrcweir    //-------------------------------------------------------------------------
74cdf0e10cSrcweir    /** allows to detect whether the modified state change is enabled
75cdf0e10cSrcweir     */
76cdf0e10cSrcweir    boolean isSetModifiedEnabled();
77cdf0e10cSrcweir};
78cdf0e10cSrcweir
79cdf0e10cSrcweir//=============================================================================
80cdf0e10cSrcweir
81cdf0e10cSrcweir}; }; }; };
82cdf0e10cSrcweir
83cdf0e10cSrcweir#endif
84