summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/util/XModifiable2.idl
blob: 895c974aeb92d13a1bd14d68bbb93771466f1829 (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
/* -*- 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_util_XModifiable2_idl__
#define __com_sun_star_util_XModifiable2_idl__

#include <com/sun/star/util/XModifiable.idl>

#include <com/sun/star/beans/PropertyVetoException.idl>



module com {  module sun {  module star {  module util {


/** allows to control modifiable state change.

    <p>
    This interface allows to prevent changing of the modified state of the
    object. It is introduced for performance optimizations, to allow to prevent
    unnecessary updates, for example while importing a document.
    Please use this interface very carefully.
    </p>
 */
interface XModifiable2: com::sun::star::util::XModifiable
{
    /** disable possibility to change modified state of the document

        @returns the value that says whether the modified state change was
                enabled before the call
            `TRUE` the changing of the modified state was already disabled
            `FALSE` the changing of the modified state was enabled

     */
    boolean disableSetModified();

    /** enable possibility to change modified state of the document

        @returns the value that says whether the modified state change was
                enabled before the call
            `TRUE` the changing of the modified state was disabled
            `FALSE` the changing of the modified state was already enabled
     */
    boolean enableSetModified();

    /** allows to detect whether the modified state change is enabled
     */
    boolean isSetModifiedEnabled();
};


}; }; }; };

#endif

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