xref: /AOO41X/main/udkapi/com/sun/star/beans/PropertyStateChangeEvent.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_PropertyStateChangeEvent_idl__
24#define __com_sun_star_beans_PropertyStateChangeEvent_idl__
25
26#ifndef __com_sun_star_lang_EventObject_idl__
27#include <com/sun/star/lang/EventObject.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyState_idl__
31#include <com/sun/star/beans/PropertyState.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module beans {
38
39//=============================================================================
40
41/** is delivered whenever the state of a "bound" property is changed.
42
43    <p>It is sent as an argument to the method of
44    <type>XPropertyStateChangeListener</type>.  </p>
45
46    <p>Normally these events are accompanied by the name, and the old
47    and new values of the changed property.  </p>
48
49    <p>Void values may be provided for the old and new values if their
50    true values are not known. </p>
51 */
52published struct PropertyStateChangeEvent: com::sun::star::lang::EventObject
53{
54    //-------------------------------------------------------------------------
55
56    /** specifies the name of the property which changes its value.
57
58        <p>This name identifies the property uniquely within an
59        <type>XPropertySet</type>. Upper and lower case are distinguished.</p>
60     */
61    string PropertyName;
62
63    //-------------------------------------------------------------------------
64
65    /** contains the implementation handle for the property.
66
67        <p>It may be -1 if the implementation has no handle. You can use this
68        handle to get values from the <type>XFastPropertySet</type>
69        interface.</p>
70     */
71    long PropertyHandle;
72
73    //-------------------------------------------------------------------------
74
75    /** contains the old value of the property.
76     */
77    com::sun::star::beans::PropertyState OldValue;
78
79    //-------------------------------------------------------------------------
80
81    /** contains the new value of the property.
82     */
83    com::sun::star::beans::PropertyState NewValue;
84
85};
86
87//=============================================================================
88
89}; }; }; };
90
91#endif
92