offapi/com/sun/star/util/ChangesEvent.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: ChangesEvent.idl,v $
  10  * $Revision: 1.7 $
  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_util_ChangesEvent_idl__
  31 #define __com_sun_star_util_ChangesEvent_idl__
  32
  33 #ifndef __com_sun_star_lang_EventObject_idl__
  34 #include <com/sun/star/lang/EventObject.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_ElementChange_idl__
  38 #include <com/sun/star/util/ElementChange.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_ChangesSet_idl__
  42 #include <com/sun/star/util/ChangesSet.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module util {
  48
  49 //=============================================================================
  50
  51 /** This event is fired when a set of changes becomes effective on the source of the event.
  52
  53     @see XChangesSet
  54     @see XChangesBatch
  55     @see XChangesListener
  56     @see XChangesNotifier
  57     @see com::sun::star::container::ContainerEvent
  58     @see ElementChange
  59  */
  60 published struct ChangesEvent: com::sun::star::lang::EventObject
  61 {
  62     //-------------------------------------------------------------------------
  63     /** contains the accessor to the common root of the changed elements.
  64
  65         <p>Type and value of the accessor depend on the service.</p>
  66      */
  67     any Base;
  68
  69     //-------------------------------------------------------------------------
  70     /** contains the changes which occurred.
  71      */
  72     ChangesSet Changes;
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif