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
  20
  21
  22 module com {  module sun {  module star {  module util {
  23
  24
  25 /** allows to control modifiable state change.
  26
  27     <p>
  28     This interface allows to prevent changing of the modified state of the
  29     object. It is introduced for performance optimizations, to allow to prevent
  30     unnecessary updates, for example while importing a document.
  31     Please use this interface very carefully.
  32     </p>
  33  */
  34 interface XModifiable2: com::sun::star::util::XModifiable
  35 {
  36     /** disable possibility to change modified state of the document
  37
  38         @returns the value that says whether the modified state change was
  39                 enabled before the call
  40             `TRUE` the changing of the modified state was already disabled
  41             `FALSE` the changing of the modified state was enabled
  42
  43      */
  44     boolean disableSetModified();
  45
  46     /** enable possibility to change modified state of the document
  47
  48         @returns the value that says whether the modified state change was
  49                 enabled before the call
  50             `TRUE` the changing of the modified state was disabled
  51             `FALSE` the changing of the modified state was already enabled
  52      */
  53     boolean enableSetModified();
  54
  55     /** allows to detect whether the modified state change is enabled
  56      */
  57     boolean isSetModifiedEnabled();
  58 };
  59
  60
  61 }; }; }; };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */