offapi/com/sun/star/util/XChangesSet.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: XChangesSet.idl,v $
  10  * $Revision: 1.8 $
  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_XChangesSet_idl__
  31 #define __com_sun_star_util_XChangesSet_idl__
  32
  33 #ifndef __com_sun_star_container_XElementAccess_idl__
  34 #include <com/sun/star/container/XElementAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  38 #include <com/sun/star/lang/WrappedTargetException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_ElementChange_idl__
  42 #include <com/sun/star/util/ElementChange.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module util {
  49
  50 //=============================================================================
  51 /** this interface enables inspecting a set of changes forming one batch transaction.
  52
  53     <p>An object implementing this interface should implement more
  54     container interfaces to access individual changes as well.  </p>
  55
  56     @see XChangesBatch
  57     @see ChangesEvent
  58     @see XChangesListener
  59     @see XChangesNotifier
  60  */
  61 published interface XChangesSet: com::sun::star::container::XElementAccess
  62 {
  63     //-------------------------------------------------------------------------
  64     /** queries for all contained changes at once.
  65
  66         @returns an array of <type>ElementChange</type> holding information about
  67             each changes  that is part of this object.
  68      */
  69     sequence<ElementChange> getAllChanges();
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif