xref: /trunk/main/offapi/com/sun/star/util/XModifiable.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_util_XModifiable_idl__
24cdf0e10cSrcweir#define __com_sun_star_util_XModifiable_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_util_XModifyBroadcaster_idl__
27cdf0e10cSrcweir#include <com/sun/star/util/XModifyBroadcaster.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyVetoException_idl__
31cdf0e10cSrcweir#include <com/sun/star/beans/PropertyVetoException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com {  module sun {  module star {  module util {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** makes the modify state of the object accessible.
42cdf0e10cSrcweir
43cdf0e10cSrcweir    <p>Additionally, it makes it possible to register listener objects, which
44cdf0e10cSrcweir    get notification whenever the status or content of the object changes.  </p>
45cdf0e10cSrcweir */
46cdf0e10cSrcweirpublished interface XModifiable: com::sun::star::util::XModifyBroadcaster
47cdf0e10cSrcweir{
48cdf0e10cSrcweir    //-------------------------------------------------------------------------
49cdf0e10cSrcweir    /** @returns
50cdf0e10cSrcweir                <TRUE/> if the object is modified.
51cdf0e10cSrcweir
52cdf0e10cSrcweir        <p>The modification is always in relation to a certain state
53cdf0e10cSrcweir        (i.e., the initial, loaded, or last stored version).
54cdf0e10cSrcweir     */
55cdf0e10cSrcweir    boolean isModified();
56cdf0e10cSrcweir
57cdf0e10cSrcweir    //-------------------------------------------------------------------------
58cdf0e10cSrcweir    /** sets the status of the <em>modified</em>-flag from outside of the
59cdf0e10cSrcweir        object.
60cdf0e10cSrcweir     */
61cdf0e10cSrcweir    void setModified( [in] boolean bModified )
62cdf0e10cSrcweir            raises( com::sun::star::beans::PropertyVetoException );
63cdf0e10cSrcweir
64cdf0e10cSrcweir};
65cdf0e10cSrcweir
66cdf0e10cSrcweir//=============================================================================
67cdf0e10cSrcweir
68cdf0e10cSrcweir}; }; }; };
69cdf0e10cSrcweir
70cdf0e10cSrcweir#endif
71