offapi/com/sun/star/util/XModifiable.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_XModifiable_idl__
  20 #define __com_sun_star_util_XModifiable_idl__
  21
  22 #include <com/sun/star/util/XModifyBroadcaster.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 /** makes the modify state of the object accessible.
  32
  33     <p>Additionally, it makes it possible to register listener objects, which
  34     get notification whenever the status or content of the object changes.  </p>
  35  */
  36 published interface XModifiable: com::sun::star::util::XModifyBroadcaster
  37 {
  38     /** @returns
  39                 `TRUE` if the object is modified.
  40
  41         <p>The modification is always in relation to a certain state
  42         (i.e., the initial, loaded, or last stored version).
  43      */
  44     boolean isModified();
  45
  46     /** sets the status of the <em>modified</em>-flag from outside of the
  47         object.
  48      */
  49     void setModified( [in] boolean bModified )
  50             raises( com::sun::star::beans::PropertyVetoException );
  51
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */