offapi/com/sun/star/util/XModifiable.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: XModifiable.idl,v $
  10  * $Revision: 1.9 $
  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_XModifiable_idl__
  31 #define __com_sun_star_util_XModifiable_idl__
  32
  33 #ifndef __com_sun_star_util_XModifyBroadcaster_idl__
  34 #include <com/sun/star/util/XModifyBroadcaster.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 /** makes the modify state of the object accessible.
  49
  50     <p>Additionally, it makes it possible to register listener objects, which
  51     get notification whenever the status or content of the object changes.      </p>
  52  */
  53 published interface XModifiable: com::sun::star::util::XModifyBroadcaster
  54 {
  55     //-------------------------------------------------------------------------
  56     /** @returns
  57                 <TRUE/> if the object is modified.
  58
  59         <p>The modification is always in relation to a certain state
  60         (i.e., the initial, loaded, or last stored version).
  61      */
  62     boolean isModified();
  63
  64     //-------------------------------------------------------------------------
  65     /** sets the status of the <em>modified</em>-flag from outside of the
  66         object.
  67      */
  68     void setModified( [in] boolean bModified )
  69             raises( com::sun::star::beans::PropertyVetoException );
  70
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif