summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/PropertyChangeEvent.idl
blob: bc7ed5d459c7ec8d3da18a02c24ed5e1f4ef60e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: PropertyChangeEvent.idl,v $
 * $Revision: 1.11 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_beans_PropertyChangeEvent_idl__
#define __com_sun_star_beans_PropertyChangeEvent_idl__

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module beans {

//=============================================================================

/** gets delivered whenever a "bound" or "constrained" property is changed.

    <p>A <type>PropertyChangeEvent</type> object is sent as an
    argument to the methods of <type>XPropertyChangeListener</type>
    and <type>XVetoableChangeListener</type>. </p>

    <p>Normally such events contain the name and the old and new
    value of the changed property.  </p>

    <p>Void values may be provided for the old and new values if their
    true values are not known. </p>
 */
published struct PropertyChangeEvent: com::sun::star::lang::EventObject
{
    //-------------------------------------------------------------------------

    /** contains the unique name of the property which changes its value.
     */
    string PropertyName;

    //-------------------------------------------------------------------------

    /** contains <true/> if further events in the same transaction occur.
     */
    boolean Further;

    //-------------------------------------------------------------------------

    /** contains the implementation handle for the property.

        <p>May be -1 if the implementation has no handle. You can use
        this handle to get values from the <type>XFastPropertySet</type>.</p>
     */
    long PropertyHandle;

    //-------------------------------------------------------------------------

    /** contains the old value of the property.
     */
    any OldValue;

    //-------------------------------------------------------------------------

    /** contains the new value of the property.
     */
    any NewValue;

};

//=============================================================================

}; }; }; };

#endif