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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XModifiable2.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29 ************************************************************************/
  30 #ifndef __com_sun_star_util_XModifiable2_idl__
  31 #define __com_sun_star_util_XModifiable2_idl__
  32
  33 #ifndef __com_sun_star_util_XModifiable_idl__
  34 #include <com/sun/star/util/XModifiable.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyVetoException_idl__
  38 #include <com/sun/star/beans/PropertyVetoException.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module util {
  45
  46 //=============================================================================
  47
  48 /** allows to control modifiable state change.
  49
  50     <p>
  51     This interface allows to prevent changing of the modified state of the
  52     object. It is introduced for performance optimizations, to allow to prevent
  53     unnecessary updates, for example while importing a document.
  54     Please use this interface very carefuly.
  55     </p>
  56  */
  57 interface XModifiable2: com::sun::star::util::XModifiable
  58 {
  59     //-------------------------------------------------------------------------
  60     /** disable possibility to change modified state of the document
  61
  62         @retuns the value that says whether the modified state change was
  63                 enabled before the call
  64             <TRUE/> the changing of the modified state was already disabled
  65             <FALSE/> the changing of the modified state was enabled
  66
  67      */
  68     boolean disableSetModified();
  69
  70     //-------------------------------------------------------------------------
  71     /** enable possibility to change modified state of the document
  72
  73         @retuns the value that says whether the modified state change was
  74                 enabled before the call
  75             <TRUE/> the changing of the modified state was disabled
  76             <FALSE/> the changing of the modified state was already enabled
  77      */
  78     boolean enableSetModified();
  79
  80     //-------------------------------------------------------------------------
  81     /** allows to detect whether the modified state change is enabled
  82      */
  83     boolean isSetModifiedEnabled();
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif
  91