offapi/com/sun/star/util/XModifiable2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_util_XModifiable2_idl__
  20 #define __com_sun_star_util_XModifiable2_idl__
  21
  22 #include <com/sun/star/util/XModifiable.idl>
  23
  24 #include <com/sun/star/beans/PropertyVetoException.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module util {
  29
  30
  31 /** allows to control modifiable state change.
  32
  33     <p>
  34     This interface allows to prevent changing of the modified state of the
  35     object. It is introduced for performance optimizations, to allow to prevent
  36     unnecessary updates, for example while importing a document.
  37     Please use this interface very carefully.
  38     </p>
  39  */
  40 interface XModifiable2: com::sun::star::util::XModifiable
  41 {
  42     /** disable possibility to change modified state of the document
  43
  44         @returns the value that says whether the modified state change was
  45                 enabled before the call
  46             `TRUE` the changing of the modified state was already disabled
  47             `FALSE` the changing of the modified state was enabled
  48
  49      */
  50     boolean disableSetModified();
  51
  52     /** enable possibility to change modified state of the document
  53
  54         @returns the value that says whether the modified state change was
  55                 enabled before the call
  56             `TRUE` the changing of the modified state was disabled
  57             `FALSE` the changing of the modified state was already enabled
  58      */
  59     boolean enableSetModified();
  60
  61     /** allows to detect whether the modified state change is enabled
  62      */
  63     boolean isSetModifiedEnabled();
  64 };
  65
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */