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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_beans_PropertyChangeEvent_idl__
  20 #define __com_sun_star_beans_PropertyChangeEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module beans {
  27
  28
  29 /** gets delivered whenever a "bound" or "constrained" property is changed.
  30
  31     <p>A PropertyChangeEvent object is sent as an
  32     argument to the methods of XPropertyChangeListener
  33     and XVetoableChangeListener. </p>
  34
  35     <p>Normally such events contain the name and the old and new
  36     value of the changed property.  </p>
  37
  38     <p>Void values may be provided for the old and new values if their
  39     true values are not known. </p>
  40  */
  41 published struct PropertyChangeEvent: com::sun::star::lang::EventObject
  42 {
  43
  44     /** contains the unique name of the property which changes its value.
  45      */
  46     string PropertyName;
  47
  48
  49     /** contains `TRUE` if further events in the same transaction occur.
  50      */
  51     boolean Further;
  52
  53
  54     /** contains the implementation handle for the property.
  55
  56         <p>May be -1 if the implementation has no handle. You can use
  57         this handle to get values from the XFastPropertySet.</p>
  58      */
  59     long PropertyHandle;
  60
  61
  62     /** contains the old value of the property.
  63      */
  64     any OldValue;
  65
  66
  67     /** contains the new value of the property.
  68      */
  69     any NewValue;
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */