udkapi/com/sun/star/beans/PropertyChangeEvent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PropertyChangeEvent.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_beans_PropertyChangeEvent_idl__
  31 #define __com_sun_star_beans_PropertyChangeEvent_idl__
  32
  33 #ifndef __com_sun_star_lang_EventObject_idl__
  34 #include <com/sun/star/lang/EventObject.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module beans {
  41
  42 //=============================================================================
  43
  44 /** gets delivered whenever a "bound" or "constrained" property is changed.
  45
  46     <p>A <type>PropertyChangeEvent</type> object is sent as an
  47     argument to the methods of <type>XPropertyChangeListener</type>
  48     and <type>XVetoableChangeListener</type>. </p>
  49
  50     <p>Normally such events contain the name and the old and new
  51     value of the changed property.  </p>
  52
  53     <p>Void values may be provided for the old and new values if their
  54     true values are not known. </p>
  55  */
  56 published struct PropertyChangeEvent: com::sun::star::lang::EventObject
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** contains the unique name of the property which changes its value.
  61      */
  62     string PropertyName;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** contains <true/> if further events in the same transaction occur.
  67      */
  68     boolean Further;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** contains the implementation handle for the property.
  73
  74         <p>May be -1 if the implementation has no handle. You can use
  75         this handle to get values from the <type>XFastPropertySet</type>.</p>
  76      */
  77     long PropertyHandle;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** contains the old value of the property.
  82      */
  83     any OldValue;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** contains the new value of the property.
  88      */
  89     any NewValue;
  90
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif