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