xref: /AOO41X/main/offapi/com/sun/star/util/XModifiable.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_util_XModifiable_idl__
28*cdf0e10cSrcweir#define __com_sun_star_util_XModifiable_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_util_XModifyBroadcaster_idl__
31*cdf0e10cSrcweir#include <com/sun/star/util/XModifyBroadcaster.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyVetoException_idl__
35*cdf0e10cSrcweir#include <com/sun/star/beans/PropertyVetoException.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir
39*cdf0e10cSrcweir//=============================================================================
40*cdf0e10cSrcweir
41*cdf0e10cSrcweirmodule com {  module sun {  module star {  module util {
42*cdf0e10cSrcweir
43*cdf0e10cSrcweir//=============================================================================
44*cdf0e10cSrcweir
45*cdf0e10cSrcweir/** makes the modify state of the object accessible.
46*cdf0e10cSrcweir
47*cdf0e10cSrcweir	<p>Additionally, it makes it possible to register listener objects, which
48*cdf0e10cSrcweir	get notification whenever the status or content of the object changes.	</p>
49*cdf0e10cSrcweir */
50*cdf0e10cSrcweirpublished interface XModifiable: com::sun::star::util::XModifyBroadcaster
51*cdf0e10cSrcweir{
52*cdf0e10cSrcweir	//-------------------------------------------------------------------------
53*cdf0e10cSrcweir	/** @returns
54*cdf0e10cSrcweir				<TRUE/> if the object is modified.
55*cdf0e10cSrcweir
56*cdf0e10cSrcweir		<p>The modification is always in relation to a certain state
57*cdf0e10cSrcweir		(i.e., the initial, loaded, or last stored version).
58*cdf0e10cSrcweir	 */
59*cdf0e10cSrcweir	boolean isModified();
60*cdf0e10cSrcweir
61*cdf0e10cSrcweir	//-------------------------------------------------------------------------
62*cdf0e10cSrcweir	/** sets the status of the <em>modified</em>-flag from outside of the
63*cdf0e10cSrcweir		object.
64*cdf0e10cSrcweir	 */
65*cdf0e10cSrcweir	void setModified( [in] boolean bModified )
66*cdf0e10cSrcweir			raises( com::sun::star::beans::PropertyVetoException );
67*cdf0e10cSrcweir
68*cdf0e10cSrcweir};
69*cdf0e10cSrcweir
70*cdf0e10cSrcweir//=============================================================================
71*cdf0e10cSrcweir
72*cdf0e10cSrcweir}; }; }; };
73*cdf0e10cSrcweir
74*cdf0e10cSrcweir#endif
75