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