offapi/com/sun/star/util/ChangesEvent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_util_ChangesEvent_idl__
  28 #define __com_sun_star_util_ChangesEvent_idl__
  29
  30 #ifndef __com_sun_star_lang_EventObject_idl__
  31 #include <com/sun/star/lang/EventObject.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_ElementChange_idl__
  35 #include <com/sun/star/util/ElementChange.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_ChangesSet_idl__
  39 #include <com/sun/star/util/ChangesSet.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module util {
  45
  46 //=============================================================================
  47
  48 /** This event is fired when a set of changes becomes effective on the source of the event.
  49
  50     @see XChangesSet
  51     @see XChangesBatch
  52     @see XChangesListener
  53     @see XChangesNotifier
  54     @see com::sun::star::container::ContainerEvent
  55     @see ElementChange
  56  */
  57 published struct ChangesEvent: com::sun::star::lang::EventObject
  58 {
  59     //-------------------------------------------------------------------------
  60     /** contains the accessor to the common root of the changed elements.
  61
  62         <p>Type and value of the accessor depend on the service.</p>
  63      */
  64     any Base;
  65
  66     //-------------------------------------------------------------------------
  67     /** contains the changes which occurred.
  68      */
  69     ChangesSet Changes;
  70
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif