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