summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/util/XChangesSet.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/util/XChangesSet.idl')
-rw-r--r--offapi/com/sun/star/util/XChangesSet.idl73
1 files changed, 73 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XChangesSet.idl b/offapi/com/sun/star/util/XChangesSet.idl
new file mode 100644
index 000000000000..b812d0389eef
--- /dev/null
+++ b/offapi/com/sun/star/util/XChangesSet.idl
@@ -0,0 +1,73 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_util_XChangesSet_idl__
+#define __com_sun_star_util_XChangesSet_idl__
+
+#ifndef __com_sun_star_container_XElementAccess_idl__
+#include <com/sun/star/container/XElementAccess.idl>
+#endif
+
+#ifndef __com_sun_star_lang_WrappedTargetException_idl__
+#include <com/sun/star/lang/WrappedTargetException.idl>
+#endif
+
+#ifndef __com_sun_star_util_ElementChange_idl__
+#include <com/sun/star/util/ElementChange.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module util {
+
+//=============================================================================
+/** this interface enables inspecting a set of changes forming one batch transaction.
+
+ <p>An object implementing this interface should implement more
+ container interfaces to access individual changes as well. </p>
+
+ @see XChangesBatch
+ @see ChangesEvent
+ @see XChangesListener
+ @see XChangesNotifier
+ */
+published interface XChangesSet: com::sun::star::container::XElementAccess
+{
+ //-------------------------------------------------------------------------
+ /** queries for all contained changes at once.
+
+ @returns an array of <type>ElementChange</type> holding information about
+ each changes that is part of this object.
+ */
+ sequence<ElementChange> getAllChanges();
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif