xref: /AOO41X/main/udkapi/com/sun/star/beans/PropertyChangeEvent.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
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_beans_PropertyChangeEvent_idl__
24#define __com_sun_star_beans_PropertyChangeEvent_idl__
25
26#ifndef __com_sun_star_lang_EventObject_idl__
27#include <com/sun/star/lang/EventObject.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module beans {
34
35//=============================================================================
36
37/** gets delivered whenever a "bound" or "constrained" property is changed.
38
39    <p>A <type>PropertyChangeEvent</type> object is sent as an
40    argument to the methods of <type>XPropertyChangeListener</type>
41    and <type>XVetoableChangeListener</type>. </p>
42
43    <p>Normally such events contain the name and the old and new
44    value of the changed property.  </p>
45
46    <p>Void values may be provided for the old and new values if their
47    true values are not known. </p>
48 */
49published struct PropertyChangeEvent: com::sun::star::lang::EventObject
50{
51    //-------------------------------------------------------------------------
52
53    /** contains the unique name of the property which changes its value.
54     */
55    string PropertyName;
56
57    //-------------------------------------------------------------------------
58
59    /** contains <true/> if further events in the same transaction occur.
60     */
61    boolean Further;
62
63    //-------------------------------------------------------------------------
64
65    /** contains the implementation handle for the property.
66
67        <p>May be -1 if the implementation has no handle. You can use
68        this handle to get values from the <type>XFastPropertySet</type>.</p>
69     */
70    long PropertyHandle;
71
72    //-------------------------------------------------------------------------
73
74    /** contains the old value of the property.
75     */
76    any OldValue;
77
78    //-------------------------------------------------------------------------
79
80    /** contains the new value of the property.
81     */
82    any NewValue;
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91