summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/document
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/document
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/document')
-rw-r--r--offapi/com/sun/star/document/AmbigousFilterRequest.idl61
-rw-r--r--offapi/com/sun/star/document/BrokenPackageRequest.idl44
-rw-r--r--offapi/com/sun/star/document/ChangedByOthersRequest.idl43
-rw-r--r--offapi/com/sun/star/document/CmisProperty.idl72
-rw-r--r--offapi/com/sun/star/document/CmisVersion.idl52
-rw-r--r--offapi/com/sun/star/document/CorruptedFilterConfigurationException.idl46
-rw-r--r--offapi/com/sun/star/document/DocumentEvent.idl72
-rw-r--r--offapi/com/sun/star/document/DocumentProperties.idl52
-rw-r--r--offapi/com/sun/star/document/DocumentRevisionListPersistence.idl40
-rw-r--r--offapi/com/sun/star/document/EmptyUndoStackException.idl43
-rw-r--r--offapi/com/sun/star/document/EventDescriptor.idl57
-rw-r--r--offapi/com/sun/star/document/EventObject.idl51
-rw-r--r--offapi/com/sun/star/document/Events.idl93
-rw-r--r--offapi/com/sun/star/document/ExoticFileLoadException.idl34
-rw-r--r--offapi/com/sun/star/document/ExportFilter.idl112
-rw-r--r--offapi/com/sun/star/document/ExtendedTypeDetection.idl97
-rw-r--r--offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl129
-rw-r--r--offapi/com/sun/star/document/FilterAdapter.idl42
-rw-r--r--offapi/com/sun/star/document/FilterConfigRefresh.idl40
-rw-r--r--offapi/com/sun/star/document/FilterFactory.idl226
-rw-r--r--offapi/com/sun/star/document/FilterOptionsRequest.idl51
-rw-r--r--offapi/com/sun/star/document/GraphicStorageHandler.idl34
-rw-r--r--offapi/com/sun/star/document/HeaderFooterSettings.idl61
-rw-r--r--offapi/com/sun/star/document/ImportFilter.idl112
-rw-r--r--offapi/com/sun/star/document/IndexedPropertyValues.idl37
-rw-r--r--offapi/com/sun/star/document/LinkTarget.idl55
-rw-r--r--offapi/com/sun/star/document/LinkTargets.idl47
-rw-r--r--offapi/com/sun/star/document/LinkUpdateModes.idl52
-rw-r--r--offapi/com/sun/star/document/LockFileCorruptRequest.idl43
-rw-r--r--offapi/com/sun/star/document/LockFileIgnoreRequest.idl43
-rw-r--r--offapi/com/sun/star/document/LockedDocumentRequest.idl50
-rw-r--r--offapi/com/sun/star/document/LockedOnSavingRequest.idl51
-rw-r--r--offapi/com/sun/star/document/MacroExecMode.idl113
-rw-r--r--offapi/com/sun/star/document/MediaDescriptor.idl619
-rw-r--r--offapi/com/sun/star/document/NamedPropertyValues.idl37
-rw-r--r--offapi/com/sun/star/document/NoSuchFilterRequest.idl57
-rw-r--r--offapi/com/sun/star/document/OOXMLDocumentPropertiesImporter.idl37
-rw-r--r--offapi/com/sun/star/document/OfficeDocument.idl176
-rw-r--r--offapi/com/sun/star/document/OleEmbeddedServerRegistration.idl45
-rw-r--r--offapi/com/sun/star/document/OwnLockOnDocumentRequest.idl54
-rw-r--r--offapi/com/sun/star/document/PDFDialog.idl50
-rw-r--r--offapi/com/sun/star/document/PrinterIndependentLayout.idl57
-rw-r--r--offapi/com/sun/star/document/RedlineDisplayType.idl51
-rw-r--r--offapi/com/sun/star/document/ReloadEditableRequest.idl50
-rw-r--r--offapi/com/sun/star/document/Settings.idl293
-rw-r--r--offapi/com/sun/star/document/TypeDetection.idl173
-rw-r--r--offapi/com/sun/star/document/UndoContextNotClosedException.idl43
-rw-r--r--offapi/com/sun/star/document/UndoFailedException.idl48
-rw-r--r--offapi/com/sun/star/document/UndoManagerEvent.idl55
-rw-r--r--offapi/com/sun/star/document/UpdateDocMode.idl62
-rw-r--r--offapi/com/sun/star/document/XActionLockable.idl72
-rw-r--r--offapi/com/sun/star/document/XBinaryStreamResolver.idl69
-rw-r--r--offapi/com/sun/star/document/XCmisDocument.idl61
-rw-r--r--offapi/com/sun/star/document/XCodeNameQuery.idl38
-rw-r--r--offapi/com/sun/star/document/XCompatWriterDocProperties.idl37
-rw-r--r--offapi/com/sun/star/document/XDocumentEventBroadcaster.idl105
-rw-r--r--offapi/com/sun/star/document/XDocumentEventListener.idl51
-rw-r--r--offapi/com/sun/star/document/XDocumentInsertable.idl58
-rw-r--r--offapi/com/sun/star/document/XDocumentLanguages.idl46
-rw-r--r--offapi/com/sun/star/document/XDocumentProperties.idl398
-rw-r--r--offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl55
-rw-r--r--offapi/com/sun/star/document/XDocumentRecovery.idl119
-rw-r--r--offapi/com/sun/star/document/XDocumentRevisionListPersistence.idl62
-rw-r--r--offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl67
-rw-r--r--offapi/com/sun/star/document/XEmbeddedObjectResolver.idl43
-rw-r--r--offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl46
-rw-r--r--offapi/com/sun/star/document/XEmbeddedObjectSupplier2.idl60
-rw-r--r--offapi/com/sun/star/document/XEmbeddedScripts.idl60
-rw-r--r--offapi/com/sun/star/document/XEventBroadcaster.idl56
-rw-r--r--offapi/com/sun/star/document/XEventListener.idl51
-rw-r--r--offapi/com/sun/star/document/XEventsSupplier.idl45
-rw-r--r--offapi/com/sun/star/document/XExporter.idl62
-rw-r--r--offapi/com/sun/star/document/XExtendedFilterDetection.idl68
-rw-r--r--offapi/com/sun/star/document/XFilter.idl72
-rw-r--r--offapi/com/sun/star/document/XFilterAdapter.idl56
-rw-r--r--offapi/com/sun/star/document/XGraphicObjectResolver.idl49
-rw-r--r--offapi/com/sun/star/document/XGraphicStorageHandler.idl53
-rw-r--r--offapi/com/sun/star/document/XImporter.idl62
-rw-r--r--offapi/com/sun/star/document/XInteractionFilterOptions.idl53
-rw-r--r--offapi/com/sun/star/document/XInteractionFilterSelect.idl67
-rw-r--r--offapi/com/sun/star/document/XLinkTargetSupplier.idl51
-rw-r--r--offapi/com/sun/star/document/XMLBasicExporter.idl49
-rw-r--r--offapi/com/sun/star/document/XMLOasisBasicExporter.idl49
-rw-r--r--offapi/com/sun/star/document/XMimeTypeInfo.idl50
-rw-r--r--offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl105
-rw-r--r--offapi/com/sun/star/document/XRedlinesSupplier.idl47
-rw-r--r--offapi/com/sun/star/document/XScriptInvocationContext.idl61
-rw-r--r--offapi/com/sun/star/document/XShapeEventBroadcaster.idl57
-rw-r--r--offapi/com/sun/star/document/XShapeEventListener.idl49
-rw-r--r--offapi/com/sun/star/document/XStorageBasedDocument.idl87
-rw-r--r--offapi/com/sun/star/document/XStorageChangeListener.idl51
-rw-r--r--offapi/com/sun/star/document/XTypeDetection.idl108
-rw-r--r--offapi/com/sun/star/document/XUndoAction.idl68
-rw-r--r--offapi/com/sun/star/document/XUndoManager.idl330
-rw-r--r--offapi/com/sun/star/document/XUndoManagerListener.idl136
-rw-r--r--offapi/com/sun/star/document/XUndoManagerSupplier.idl48
-rw-r--r--offapi/com/sun/star/document/XVbaMethodParameter.idl50
-rw-r--r--offapi/com/sun/star/document/XViewDataSupplier.idl63
-rw-r--r--offapi/com/sun/star/document/XXMLBasicExporter.idl52
99 files changed, 7714 insertions, 0 deletions
diff --git a/offapi/com/sun/star/document/AmbigousFilterRequest.idl b/offapi/com/sun/star/document/AmbigousFilterRequest.idl
new file mode 100644
index 000000000..d89c8b272
--- /dev/null
+++ b/offapi/com/sun/star/document/AmbigousFilterRequest.idl
@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_AmbigousFilterRequest_idl__
+#define __com_sun_star_document_AmbigousFilterRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+
+
+module com { module sun { module star { module document {
+
+/** should be used for interaction to handle states of ambiguous filter detection
+
+ <p>
+ This exception indicates, that generic filter detection can't decide which of
+ two filters is the right one. In this case an interaction will be made.
+ Given URL can be used to decide between given two filters.
+ Decision can be made e.g. by a dialog, on which the user must select one
+ of these filters.
+ A possible continuation of type XInteractionFilterSelect
+ transport this decision back to source of started interaction.
+ </p>
+
+ @see XInteractionFilterSelect
+*/
+published exception AmbigousFilterRequest : ::com::sun::star::uno::Exception
+{
+ /** transport URL which couldn't be detected right
+ */
+ string URL;
+
+ /** transport the preselected filter
+ */
+ string SelectedFilter;
+
+ /** transport the real detected filter, which stands in conflict to the pre selected one
+ */
+ string DetectedFilter;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/BrokenPackageRequest.idl b/offapi/com/sun/star/document/BrokenPackageRequest.idl
new file mode 100644
index 000000000..627e6da7b
--- /dev/null
+++ b/offapi/com/sun/star/document/BrokenPackageRequest.idl
@@ -0,0 +1,44 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_BrokenPackageRequest_idl__
+#define __com_sun_star_document_BrokenPackageRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle in case package is broken.
+
+ @since OOo 1.1.2
+*/
+published exception BrokenPackageRequest : ::com::sun::star::uno::Exception
+{
+ /** The name of the document that is broken
+ */
+ string aName;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/ChangedByOthersRequest.idl b/offapi/com/sun/star/document/ChangedByOthersRequest.idl
new file mode 100644
index 000000000..cadbbf362
--- /dev/null
+++ b/offapi/com/sun/star/document/ChangedByOthersRequest.idl
@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_ChangedByOthersRequest_idl__
+#define __com_sun_star_document_ChangedByOthersRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/frame/XModel.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle to query user decision in case the document
+ being saved was already stored by another user during the editing.
+
+ @since OOo 3.1
+*/
+published exception ChangedByOthersRequest : ::com::sun::star::uno::Exception
+{
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/CmisProperty.idl b/offapi/com/sun/star/document/CmisProperty.idl
new file mode 100644
index 000000000..b06b84a0e
--- /dev/null
+++ b/offapi/com/sun/star/document/CmisProperty.idl
@@ -0,0 +1,72 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_CmisProperty_idl__
+#define __com_sun_star_document_CmisProperty_idl__
+
+module com { module sun { module star { module document {
+
+/** specifies a CMIS property.
+ */
+struct CmisProperty
+{
+ /** unique ID of the Cmis property
+ */
+ string Id;
+
+ /** specifies the display name of the CMIS property.
+ */
+ string Name;
+
+ /** type of the property
+ */
+ string Type;
+
+ /** specifies if the property is updatable.
+ */
+ boolean Updatable;
+
+ /** specifies if the property is required and
+ can not be empty.
+ */
+ boolean Required;
+
+ /** specifies if the property has multiple value
+ */
+ boolean MultiValued;
+
+ /** specifies if the property value can be freely set
+ or is restricted from a list of choices.
+ */
+ boolean OpenChoice;
+
+ /** specifies the possible choices of the values.
+ */
+ any Choices;
+
+ /** specifies value of the property
+ */
+ any Value;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/CmisVersion.idl b/offapi/com/sun/star/document/CmisVersion.idl
new file mode 100644
index 000000000..81712830a
--- /dev/null
+++ b/offapi/com/sun/star/document/CmisVersion.idl
@@ -0,0 +1,52 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_CmisVersion_idl__
+#define __com_sun_star_document_CmisVersion_idl__
+
+#include <com/sun/star/util/DateTime.idl>
+
+module com { module sun { module star { module document {
+
+/** specifies a CMIS document version.
+ */
+struct CmisVersion
+{
+ /** unique ID of the Cmis version
+ */
+ string Id;
+
+ /** specifies the time when the revision was created.
+ */
+ util::DateTime TimeStamp;
+
+ /** contains the author that created the version.
+ */
+ string Author;
+
+ /** contains the comment the author has left.
+ */
+ string Comment;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/CorruptedFilterConfigurationException.idl b/offapi/com/sun/star/document/CorruptedFilterConfigurationException.idl
new file mode 100644
index 000000000..fddd2ecd5
--- /dev/null
+++ b/offapi/com/sun/star/document/CorruptedFilterConfigurationException.idl
@@ -0,0 +1,46 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_CorruptedFilterConfigurationException_idl__
+#define __com_sun_star_document_CorruptedFilterConfigurationException_idl__
+
+#include <com/sun/star/uno/RuntimeException.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** This exception is thrown in case the global filter configuration
+ does not exists or contains corrupted data.
+
+ @since OOo 2.0
+ */
+published exception CorruptedFilterConfigurationException : ::com::sun::star::uno::RuntimeException
+{
+ /** Instead of the message part of an exception, this value
+ describe the type of corruption more in detail. */
+ string Details;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/DocumentEvent.idl b/offapi/com/sun/star/document/DocumentEvent.idl
new file mode 100644
index 000000000..5e3d00f2d
--- /dev/null
+++ b/offapi/com/sun/star/document/DocumentEvent.idl
@@ -0,0 +1,72 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_DocumentEvent_idl__
+#define __com_sun_star_document_DocumentEvent_idl__
+
+#include <com/sun/star/lang/EventObject.idl>
+#include <com/sun/star/frame/XController2.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** describes an event happening in an OfficeDocument
+
+ <p>The com::sun::star::lang::EventObject::Source member
+ of the base type refers to the document which broadcasts the event.</p>
+
+ <p>This type is the successor of the EventObject type, which should not be used
+ anymore.</p>
+
+ @see XDocumentEventBroadcaster
+ @since OOo 3.1
+ */
+struct DocumentEvent : ::com::sun::star::lang::EventObject
+{
+ /** specifies the name of the event.
+
+ <p>It's the responsibility of the component supporting the XDocumentEventBroadcaster
+ interface to specify which events it supports.</p>
+ */
+ string EventName;
+
+ /** denotes the view respectively controller which the event applies to.
+
+ <p>Might be `NULL` if the event is not related to a concrete view of
+ the document.</p>
+ */
+ ::com::sun::star::frame::XController2
+ ViewController;
+
+ /** contains supplemental information about the event which is being notified
+
+ <p>The semantics of this additional information needs to be specified by the broadcaster
+ of the event.</p>
+ */
+ any Supplement;
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/DocumentProperties.idl b/offapi/com/sun/star/document/DocumentProperties.idl
new file mode 100644
index 000000000..f4705ba76
--- /dev/null
+++ b/offapi/com/sun/star/document/DocumentProperties.idl
@@ -0,0 +1,52 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_DocumentProperties_idl__
+#define __com_sun_star_document_DocumentProperties_idl__
+
+#include <com/sun/star/document/XDocumentProperties.idl>
+
+
+module com { module sun { module star { module document {
+
+/** provides document-specific information such as the author, creation date,
+ and user-defined fields.
+
+ <p>
+ This service replaces the deprecated DocumentInfo and
+ StandaloneDocumentInfo services.
+ </p>
+
+ @since OOo 3.0
+
+ @see XDocumentProperties
+ @see XDocumentPropertiesSupplier
+ */
+published service DocumentProperties : XDocumentProperties
+{
+ /** constructs default-initialized instance
+ */
+ create();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/DocumentRevisionListPersistence.idl b/offapi/com/sun/star/document/DocumentRevisionListPersistence.idl
new file mode 100644
index 000000000..79a9ee3f9
--- /dev/null
+++ b/offapi/com/sun/star/document/DocumentRevisionListPersistence.idl
@@ -0,0 +1,40 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_DocumentRevisionListPersistence_idl__
+#define __com_sun_star_document_DocumentRevisionListPersistence_idl__
+
+#include <com/sun/star/document/XDocumentRevisionListPersistence.idl>
+
+
+
+module com { module sun { module star { module document {
+
+/** interface to maintain a list of document revisions
+
+ <p>
+ <p>
+ */
+service DocumentRevisionListPersistence : XDocumentRevisionListPersistence;
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/EmptyUndoStackException.idl b/offapi/com/sun/star/document/EmptyUndoStackException.idl
new file mode 100644
index 000000000..305c831a0
--- /dev/null
+++ b/offapi/com/sun/star/document/EmptyUndoStackException.idl
@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_EmptyUndoStackException_idl__
+#define __com_sun_star_document_EmptyUndoStackException_idl__
+
+#include <com/sun/star/util/InvalidStateException.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** is raised when an operation is attemption at an XUndoManager which requires a non-empty stack
+ of undo actions, and this requirement is not fulfilled.
+ @since OOo 3.4
+ */
+exception EmptyUndoStackException : ::com::sun::star::util::InvalidStateException
+{
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/EventDescriptor.idl b/offapi/com/sun/star/document/EventDescriptor.idl
new file mode 100644
index 000000000..9fa3f6ec1
--- /dev/null
+++ b/offapi/com/sun/star/document/EventDescriptor.idl
@@ -0,0 +1,57 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_EventDescriptor_idl__
+#define __com_sun_star_document_EventDescriptor_idl__
+
+
+module com { module sun { module star { module document {
+
+/** specifies an event binding for a document or a document content
+
+ @see Events
+ @see XEventsSupplier
+ */
+published service EventDescriptor
+{
+ /** specifies the type of the event handler
+
+ <p>
+ Usually this is one of the following:
+ <ul>
+ <li>"None"</li>
+ <li>"StarBasic"</li>
+ <li>"JavaScript"</li>
+ <li>"Presentation"</li>
+ </ul>
+ This list is extensible.
+ </p>
+ */
+ [property] string EventType;
+
+ /** specifies the script source code
+ */
+ [property] string Script;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/EventObject.idl b/offapi/com/sun/star/document/EventObject.idl
new file mode 100644
index 000000000..cb406d316
--- /dev/null
+++ b/offapi/com/sun/star/document/EventObject.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_EventObject_idl__
+#define __com_sun_star_document_EventObject_idl__
+
+#include <com/sun/star/lang/EventObject.idl>
+
+
+module com { module sun { module star { module document {
+
+/** is thrown on document and document content events
+
+ @see XEventListener
+ @see XEventBroadcaster
+
+ @deprecated
+ @see DocumentEvent
+ */
+published struct EventObject: com::sun::star::lang::EventObject
+{
+ /** specifies the name of the occurred event
+
+ <p>
+ For a list of possible event names see Events.
+ </p>
+ */
+ string EventName;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/Events.idl b/offapi/com/sun/star/document/Events.idl
new file mode 100644
index 000000000..ec8875c7a
--- /dev/null
+++ b/offapi/com/sun/star/document/Events.idl
@@ -0,0 +1,93 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_Events_idl__
+#define __com_sun_star_document_Events_idl__
+
+#include <com/sun/star/container/XNameReplace.idl>
+
+
+module com { module sun { module star { module document {
+
+/** is a collection of all events supported by a document or content of a
+ document
+
+ <p>
+ Such Events will be broadcasted by a XEventBroadcaster
+ to any XEventListener packed as EventObjects.
+ </p>
+ */
+published service Events
+{
+ /** offers access to the list of EventDescriptors
+
+ <p>
+ The following events are usually available:
+ <dl>
+ <dt>OnAlphaCharInput</dt>
+ <dt>OnClick</dt>
+ <dt>OnCloseApp</dt>
+ <dt>OnCopyTo</dt>
+ <dt>OnCopyToDone</dt>
+ <dt>OnError</dt>
+ <dt>OnFocus</dt>
+ <dt>OnInsertDone</dt>
+ <dt>OnInsertStart</dt>
+ <dt>OnLoad</dt>
+ <dt>OnLoadCancel</dt>
+ <dt>OnLoadDone</dt>
+ <dt>OnLoadError</dt>
+ <dt>OnLoadFinished</dt>
+ <dt>OnMailMerge</dt>
+ <dt>OnMailMergeFinished</dt>
+ <dt>OnModifyChanged</dt>
+ <dt>OnMouseOut</dt>
+ <dt>OnMouseOver</dt>
+ <dt>OnMove</dt>
+ <dt>OnNew</dt>
+ <dt>OnNewMail</dt>
+ <dt>OnNonAlphaCharInput</dt>
+ <dt>OnPageCountChange</dt>
+ <dt>OnPrepareUnload</dt>
+ <dt>OnPrepareViewClosing</dt>
+ <dt>OnPrint</dt>
+ <dt>OnResize</dt>
+ <dt>OnSave</dt>
+ <dt>OnSaveAs</dt>
+ <dt>OnSaveAsDone</dt>
+ <dt>OnSaveDone</dt>
+ <dt>OnSaveFinished</dt>
+ <dt>OnSelect</dt>
+ <dt>OnStartApp</dt>
+ <dt>OnToggleFullscreen</dt>
+ <dt>OnUnfocus</dt>
+ <dt>OnUnload</dt>
+ <dt>OnViewCreated</dt>
+ <dt>OnViewClosed</dt>
+ </dl>
+ </p>
+ */
+ interface com::sun::star::container::XNameReplace;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/ExoticFileLoadException.idl b/offapi/com/sun/star/document/ExoticFileLoadException.idl
new file mode 100644
index 000000000..e742f7edb
--- /dev/null
+++ b/offapi/com/sun/star/document/ExoticFileLoadException.idl
@@ -0,0 +1,34 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+#ifndef __com_sun_star_document_ExoticFileLoadException_idl__
+#define __com_sun_star_document_ExoticFileLoadException_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+
+module com { module sun { module star { module document {
+
+/** An exception used to notify loading of an exotic file format
+ @since LibreOffice 6.1
+*/
+exception ExoticFileLoadException : ::com::sun::star::uno::Exception
+{
+ /** contains the URL of the document
+ */
+ string URL;
+
+ /** contains the UI name of the filter
+ */
+ string FilterUIName;
+};
+
+
+}; }; }; };
+
+#endif
+
diff --git a/offapi/com/sun/star/document/ExportFilter.idl b/offapi/com/sun/star/document/ExportFilter.idl
new file mode 100644
index 000000000..c8654d7cf
--- /dev/null
+++ b/offapi/com/sun/star/document/ExportFilter.idl
@@ -0,0 +1,112 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_ExportFilter_idl__
+#define __com_sun_star_document_ExportFilter_idl__
+
+#include <com/sun/star/document/XExporter.idl>
+#include <com/sun/star/document/XFilter.idl>
+#include <com/sun/star/lang/XInitialization.idl>
+#include <com/sun/star/container/XNamed.idl>
+
+
+module com { module sun { module star { module document {
+
+/** filter for exports
+
+ <p>
+ Such filters can be used for exporting a content.
+ Of course it's possible to combine it with the service ImportFilter
+ if import functionality should be available at same implementation too.
+ </p>
+
+ @see ImportFilter
+ */
+published service ExportFilter
+{
+ /** set source(!) document for this filter
+
+ <p>
+ The document must be used as the source for following filter operation.
+ Any content from there will be exported to another format.
+ </p>
+ */
+ interface XExporter;
+
+ /** filter interface
+
+ <p>
+ It's used to filter a document at saving time.
+ The source document should be already set by using another interface
+ XExporter which is supported by this service too.
+ </p>
+
+ <p>
+ Tip:<br>
+ If same implementation provides the service ImportFilter too,
+ code must distinguish between filtering from a source document (for export) or
+ filtering to a target document (for import). This can be recognized by saving
+ state of used interfaces XExporter or XImporter!
+ Otherwise it's not clear which action is required here.
+ </p>
+ */
+ interface XFilter;
+
+ /** support initialization of filter with its own configuration
+
+ <p>
+ A filter object must be created by global service FilterFactory.
+ If filter supports this optional interface, he will be initialized by the factory directly
+ after creation. The factory will pass the following information to this new instance:
+ <ul>
+ <li>first item will be a set of configuration data of the filter</li>
+ <li>after that will follow may given optional parameters of call
+ com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments()
+ of service FilterFactory.
+ </li>
+ </ul>
+ See description of service FilterFactory::XNameContainer for a description of
+ possible configuration data.
+ </p>
+ */
+ [optional] interface com::sun::star::lang::XInitialization;
+
+ /** provides access to the internal name of this filter
+
+ <p>
+ This internal filter name can be used on service FilterFactory
+ to get further information about it (e.g. his registration for mime types or extensions etc.)
+ It's important that returned string is the "internal name" of the filter which must be
+ unambiguous against all other registered filters in current installation.
+ </p>
+ <p>
+ <strong>Attention!</strong><br>
+ Supported method setName() should be ignored or forwarded to the FilterFactory.
+ It's not allowed to set it directly to the configuration. Because it depends
+ from real implementation of the FilterFactory if it will be allowed or not!
+ </p>
+ */
+ [optional] interface com::sun::star::container::XNamed;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/ExtendedTypeDetection.idl b/offapi/com/sun/star/document/ExtendedTypeDetection.idl
new file mode 100644
index 000000000..9008d430b
--- /dev/null
+++ b/offapi/com/sun/star/document/ExtendedTypeDetection.idl
@@ -0,0 +1,97 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_ExtendedTypeDetection_idl__
+#define __com_sun_star_document_ExtendedTypeDetection_idl__
+
+#include <com/sun/star/document/XExtendedFilterDetection.idl>
+
+
+module com { module sun { module star { module document {
+
+/** describes a class of service which will be used for deep TypeDetection
+ in a generic way
+
+ <p>
+ Due to the registered types, flat TypeDetection is already possible, i.e.
+ the assignment of types (e.g. to a URL) only on the basis of configuration data.
+ If, however, you imagine special cases (e.g. modifying the file extension of a
+ Writer file from .sdw to .doc), it quickly becomes clear that you cannot always
+ get a correct result with flat detection. To be certain to get correct results,
+ you need deep detection, i.e. the file itself has to be examined.
+ And that is exactly the function of DetectServices. They get all the information
+ collected so far on a document and then decide which type to assign it to.
+ In the new modular model, such a detector is meant as UNO service which registers
+ itself in the office and is requested by the generic type detection if necessary.
+ <br>
+ Therefore you need two pieces of information:
+ <ul>
+ <li>
+ The <strong>ServiceName</strong> - This must be a valid UNO service name.
+ It is also an entry in the corresponding configuration list.
+ <br>
+ Example: "com.company.division.DetectService"
+ <br>
+ Note that this really means the implementation name of the service.
+ Because it's not possible otherwise to distinguish between more than one
+ registered detect services in same office installation! But it's possible for
+ the generic type detection to create a UNO service by his implementation name too.
+ </li>
+ <li>
+ A list of <strong>Types</strong> able to be recognized by this service -
+ You can also implement and register detectors for groups of types.
+ </li>
+ </ul>
+ See service TypeDetection and his configuration for further information.
+ </p>
+
+ @see TypeDetection
+ */
+published service ExtendedTypeDetection
+{
+ /** makes the deep detection
+
+ <p>
+ Generic type detection searches for a registered DetectService for an
+ already flat detected type. If any could be found it will be created and
+ used by calling methods of this interface. It gets a MediaDescriptor
+ which contains information about the document which should be detected and must return
+ <ul>
+ <li>an internal type name for detected format</li>
+ <li>or `NULL` if format is unknown nor supported.</li>
+ </ul>
+ May be that given descriptor already includes the opened document stream as parameter
+ MediaDescriptor::InputStream. Then this one should be used every time.
+ If it's not included in descriptor the value of MediaDescriptor::URL
+ must be used to open requested resource by this service.
+ <br>
+ Note: The stream should be added to the descriptor if it wasn't a part of them before.
+ So further steps on the whole detection process can use it and will perform her work.
+ It's further not allowed to hold a reference to this stream any longer. Only copies
+ will be valid then. Otherwise nobody can close this stream then.
+ </p>
+ */
+ interface XExtendedFilterDetection;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl b/offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl
new file mode 100644
index 000000000..a9fe2a77f
--- /dev/null
+++ b/offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl
@@ -0,0 +1,129 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_ExtendedTypeDetectionFactory_idl__
+#define __com_sun_star_document_ExtendedTypeDetectionFactory_idl__
+
+#include <com/sun/star/lang/XMultiServiceFactory.idl>
+#include <com/sun/star/container/XNameContainer.idl>
+#include <com/sun/star/container/XContainerQuery.idl>
+#include <com/sun/star/util/XFlushable.idl>
+
+
+module com { module sun { module star { module document {
+
+/** factory to create extended type detection components.
+
+ <p>
+ This factory implements read/write access on the underlying configuration set.
+ and further a validate and flush mechanism for more performance and a special query mode
+ can be used here too.
+ </p>
+
+ @since OOo 1.1.2
+ */
+published service ExtendedTypeDetectionFactory
+{
+ /** factory interface to create and initialize extended type detection components.
+
+ <p>
+ A detection component must be specified by its UNO implementation name and will be created then.
+ Every new created component can be initialized with its own configuration data
+ and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the
+ service must support the optional interface com::sun::star::lang::XInitialization.
+ The arguments parameter will have the following structure:
+ <ul>
+ <li>sequence< Any >[0] contains a sequence< com::sun::star::beans::PropertyValue >,
+ which represent the configuration data set of this detector component. The used properties are the same, as
+ they are available at the container interface of this factory service. (see below)</li>
+ <li>Every following item of the argument list sequence< Any >[1..n] contains the copied argument of the
+ corresponding createInstanceWithArguments() call. That means: Item 0 or the original list was copied as
+ item 1 of the destination list ... etc.
+ </ul>
+ </p>
+ */
+ interface com::sun::star::lang::XMultiServiceFactory;
+
+ /** provides read access to the complete set of configuration data.
+
+ <p>
+ Every container item is specified as a set of properties and will be
+ represented by a sequence< com::sun::star::beans::PropertyValue > structure.
+ Follow properties are supported:
+ (But note: not all of them must be present every time!)
+ </p>
+ <table border=1>
+ <tr>
+ <td><strong>Property Name</strong></td>
+ <td><strong>Value Type</strong></td>
+ <td><strong>Description</strong></td>
+ </tr>
+ <tr>
+ <td><em>Name</em></td>
+ <td>[string]</td>
+ <td>It means the UNO implementation name of the detector component.
+ Note: It means the really the implementation instead of the UNO service name.
+ Because it's not possible to distinguish between more than one components; if all of them
+ uses a generic service identifier!</td>
+ </tr>
+ <tr>
+ <td><em>Types</em></td>
+ <td>[sequence< string >]</td>
+ <td>It's a list of all types, which can be detected by this extended detection component.
+ All items of this list must match an item of the TypeDetection container service.</td>
+ </tr>
+ </table>
+ </p>
+ */
+ interface com::sun::star::container::XNameAccess;
+
+ /** provides a write access to the configuration data.
+ */
+ [optional] interface com::sun::star::container::XNameContainer;
+
+ /** provides search on the configuration data set.
+
+ <p>
+ Against simple property search it provides some complex algorithms too.
+ For further information please read the SDK documentation.
+ </p>
+ */
+ [optional] interface com::sun::star::container::XContainerQuery;
+
+ /** can be used to perform container changes.
+
+ <p>
+ Because the complexness of such configuration set can be very high,
+ it seems not very useful to update the underlying configuration layer
+ on every container change request immediately. Another strategy can be to
+ make all changes (adding/changing/removing of items) and call flush at the end.
+ That will validate the whole container and reject inconsistent data sets.
+ Only in case all made changes was correct, they will be written back to the
+ configuration. Further this interface provides the possibility, that interested
+ changes listener can be registered too.
+ </p>
+ */
+ [optional] interface com::sun::star::util::XFlushable;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/FilterAdapter.idl b/offapi/com/sun/star/document/FilterAdapter.idl
new file mode 100644
index 000000000..ed9f7db25
--- /dev/null
+++ b/offapi/com/sun/star/document/FilterAdapter.idl
@@ -0,0 +1,42 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef _COM_SUN_STAR_DOCUMENT_FILTERADAPTER_IDL__
+#define _COM_SUN_STAR_DOCUMENT_FILTERADAPTER_IDL__
+
+#include <com/sun/star/document/XFilterAdapter.idl>
+
+
+module com { module sun { module star { module document {
+
+ /* Provides access to user to filters written to use the FilterAdapter
+
+ @since OOo 1.1.2
+ */
+published service FilterAdapter
+ {
+ interface XFilterAdapter;
+ };
+ };
+ };
+ };
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/FilterConfigRefresh.idl b/offapi/com/sun/star/document/FilterConfigRefresh.idl
new file mode 100644
index 000000000..cd2856105
--- /dev/null
+++ b/offapi/com/sun/star/document/FilterConfigRefresh.idl
@@ -0,0 +1,40 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_FilterConfigRefresh_idl__
+#define __com_sun_star_document_FilterConfigRefresh_idl__
+
+#include <com/sun/star/util/XRefreshable.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/**
+ @since LibreOffice 4.1
+ */
+service FilterConfigRefresh : com::sun::star::util::XRefreshable;
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/FilterFactory.idl b/offapi/com/sun/star/document/FilterFactory.idl
new file mode 100644
index 000000000..acb0280e2
--- /dev/null
+++ b/offapi/com/sun/star/document/FilterFactory.idl
@@ -0,0 +1,226 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_FilterFactory_idl__
+#define __com_sun_star_document_FilterFactory_idl__
+
+#include <com/sun/star/lang/XMultiServiceFactory.idl>
+#include <com/sun/star/container/XNameContainer.idl>
+#include <com/sun/star/container/XContainerQuery.idl>
+#include <com/sun/star/util/XFlushable.idl>
+
+
+module com { module sun { module star { module document {
+
+/** factory to create filter components.
+
+ <p>
+ After a generic TypeDetection an internal type name
+ will be known. Further a generic com::sun::star::frame::FrameLoader
+ can use this information, to search a suitable filter (may the default filter) at
+ this factory and use it for loading the document into a specified frame.
+ </p>
+
+ <p>
+ This factory implements read/write access on the underlying configuration set.
+ and further a validate and flush mechanism for more performance and a special query mode
+ can be used here too.
+ </p>
+ */
+published service FilterFactory
+{
+ /** factory interface to create and initialize filter components.
+
+ <p>
+ <strong>Current behavior</strong><p>
+ The methods createInstance() or createInstanceWithArguments() of this interface must be
+ called with an internal type name!. This name is used internally to search a suitable
+ (mostly the default) filter for this type then. The found filter will be created, initialized
+ and returned then. Creation of a filter by using its internal filter name directly can be
+ reached by using createInstanceWithArguments() with an optional property "FilterName" only.
+ See the following example:
+
+ @code{.java}
+ private com.sun.star.uno.XInterface createFilterDirect( com.sun.star.lang.XMultiServiceFactory xFilterFactory ,
+ java.lang.String sInternalFilterName )
+ {
+ com.sun.star.beans.PropertyValue aFilterProp = new com.sun.star.beans.PropertyValue();
+ aFilterProp.Name = "FilterName";
+ aFilterProp.Value = sInternalFilterName;
+
+ com.sun.star.uno.Any[] lProps = new com.sun.star.uno.Any[1];
+ lProps[0] = aFilterProp;
+
+ java.lang.Object aFilter = xFilterFactory.createInstanceWithArguments("", lProps);
+ return (com.sun.star.uno.XInterface)UnoRuntime.queryInterface(com.sun.star.uno.XInterface.class, aFilter);
+ }
+ @endcode
+ </p>
+
+ <p>
+ <strong>Proposed behavior</strong><p>
+ Searching of a suitable filter for a given internal type name, must be done by the new interface
+ com::sun::star::container::XContainerQuery, available on this factory too.
+ The factory interface can be used to create filter components by its internal filter name only.
+ </p>
+
+ <p>
+ <strong>How it can be distinguished?</strong><p>
+ The new proposed implementation will throw a com::sun::star::container::NoSuchElementException
+ if the first parameter of createInstance() or createInstanceWithArguments() does not match to a valid container (means
+ filter) item. Further it will throw a com::sun::star::lang::IllegalArgumentException if the optional
+ parameter "FilterName" could not be detected inside the argument list of call createInstanceWithArguments().
+ </p>
+
+ <p>
+ <strong>Initialization of a filter component</strong><p>
+ Every filter, which was created by this factory can(!) be initialized with its own configuration data
+ and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the filter
+ instance must support the optional interface com::sun::star::lang::XInitialization.
+ The arguments parameter will have the following structure:
+ <ul>
+ <li>sequence< Any >[0] contains a sequence< com::sun::star::beans::PropertyValue >,
+ which represent the configuration data set of this filter. The used properties are the same, as
+ they are available at the container interface of this factory service. (see below)</li>
+ <li>Every following item of the argument list sequence< Any >[1..n] contains the copied argument of the
+ corresponding createInstanceWithArguments() call. That means: Item 0 or the original list was copied as
+ item 1 of the destination list ... etc.
+ </ul>
+ </p>
+ */
+ interface com::sun::star::lang::XMultiServiceFactory;
+
+ /** provides read access to the complete set of configuration data.
+
+ <p>
+ Every container item is specified as a set of properties and will be
+ represented by a sequence< com::sun::star::beans::PropertyValue > structure.
+ Follow properties are supported:
+ (But note: not all of them must be present every time!)
+ </p>
+ <table border=1>
+ <tr>
+ <td><strong>Property Name</strong></td>
+ <td><strong>Value Type</strong></td>
+ <td><strong>Description</strong></td>
+ </tr>
+ <tr>
+ <td><em>Name</em></td>
+ <td>[string]</td>
+ <td>The internal name is the only value, which makes a container item unique.</td>
+ </tr>
+ <tr>
+ <td><em>UIName</em></td>
+ <td>[string]</td>
+ <td>It contains the localized name for this filter for the current locale.</td>
+ </tr>
+ <tr>
+ <td><em>UINames</em></td>
+ <td>[sequence< string >]</td>
+ <td>It contains all available localized names for this filter. The are organized
+ in pairs and represented as a structure of sequence< com::sun::star::beans::PropertyValue >.
+ The name of such property must be interpreted as locale; its value as the localized
+ filter name corresponding to this locale.</td>
+ </tr>
+ <tr>
+ <td><em>Type</em></td>
+ <td>[string]</td>
+ <td>Every filter is registered for a type. This value contains the internal name of it.
+ (see service TypeDetection for further information)</td>
+ </tr>
+ <tr>
+ <td><em>DocumentService</em></td>
+ <td>[string]</td>
+ <td>It's the UNO service name of the document type, which can be handled by this filter.
+ (e.g. com::sun::star::text::TextDocument)</td>
+ </tr>
+ <tr>
+ <td><em>FilterService</em></td>
+ <td>[string]</td>
+ <td>It means the UNO implementation name of the filter component.
+ Note: It really means the implementation instead of the UNO service name.
+ Because it's not possible to distinguish between more than one filters; if all of them
+ uses a generic identifier!</td>
+ </tr>
+ <tr>
+ <td><em>Flags</em></td>
+ <td>[integer]</td>
+ <td>They describe the filter more specific.<br>
+ (e.g. they mark it as IMPORT/EXPORT or DEFAULT filter.)</td>
+ </tr>
+ <tr>
+ <td><em>UserData</em></td>
+ <td>[string]</td>
+ <td>This field contains filter specific configuration data.</td>
+ </tr>
+ <tr>
+ <td><em>FileFormatVersion</em></td>
+ <td>[integer]</td>
+ <td>It specifies the supported file format version if there exist more than ones.</td>
+ </tr>
+ <tr>
+ <td><em>TemplateName</em></td>
+ <td>[string]</td>
+ <td>It's the name of a suitable default template.</td>
+ </tr>
+ </table>
+ </p>
+
+ <p>
+ Note:<br>
+ All elements of this container will be addressed by his internal name,
+ and it must be an unambiguous value.
+ </p>
+ */
+ interface com::sun::star::container::XNameAccess;
+
+ /** provides a write access to the configuration data.
+ */
+ [optional] interface com::sun::star::container::XNameContainer;
+
+ /** provides search on the configuration data set.
+
+ <p>
+ Against simple property search it provides some complex algorithms too.
+ For further information please read the SDK documentation.
+ </p>
+ */
+ interface com::sun::star::container::XContainerQuery;
+
+ /** can be used to perform container changes.
+
+ <p>
+ Because the complexness of such configuration set can be very high,
+ it seems not very useful to update the underlying configuration layer
+ on every container change request immediately. Another strategy can be to
+ make all changes (adding/changing/removing of items) and call flush at the end.
+ That will validate the whole container and reject inconsistent data sets.
+ Only in case all made changes was correct, they will be written back to the
+ configuration. Further this interface provides the possibility, that interested
+ changes listener can be registered too.
+ </p>
+ */
+ [optional] interface com::sun::star::util::XFlushable;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/FilterOptionsRequest.idl b/offapi/com/sun/star/document/FilterOptionsRequest.idl
new file mode 100644
index 000000000..2bf536836
--- /dev/null
+++ b/offapi/com/sun/star/document/FilterOptionsRequest.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_FilterOptionsRequest_idl__
+#define __com_sun_star_document_FilterOptionsRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/frame/XModel.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle to get filter options.
+
+ @since OOo 1.1.2
+*/
+published exception FilterOptionsRequest : ::com::sun::star::uno::Exception
+{
+ /** The model of the document that should be provided to filters
+ that supports XExporter interface.
+ */
+ ::com::sun::star::frame::XModel rModel;
+
+ /** The Media-descriptor of the document
+ */
+ sequence< com::sun::star::beans::PropertyValue > rProperties;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/GraphicStorageHandler.idl b/offapi/com/sun/star/document/GraphicStorageHandler.idl
new file mode 100644
index 000000000..a29f181f3
--- /dev/null
+++ b/offapi/com/sun/star/document/GraphicStorageHandler.idl
@@ -0,0 +1,34 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ */
+
+#ifndef __com_sun_star_document_GraphicStorageHandler_idl__
+#define __com_sun_star_document_GraphicStorageHandler_idl__
+
+#include <com/sun/star/document/GraphicStorageHandler.idl>
+#include <com/sun/star/embed/XStorage.idl>
+
+module com { module sun { module star { module document {
+
+/**
+ Default implementation of XGraphicStorageHandler
+
+ @since LibreOffice 6.1
+ */
+service GraphicStorageHandler : XGraphicStorageHandler
+{
+ createWithStorage([in] com::sun::star::embed::XStorage Storage);
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/HeaderFooterSettings.idl b/offapi/com/sun/star/document/HeaderFooterSettings.idl
new file mode 100644
index 000000000..799cb81c6
--- /dev/null
+++ b/offapi/com/sun/star/document/HeaderFooterSettings.idl
@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_HeaderFooterSettings_idl__
+#define __com_sun_star_document_HeaderFooterSettings_idl__
+
+#include <com/sun/star/beans/XPropertySet.idl>
+
+
+module com { module sun { module star { module document {
+
+
+// Note: Where is the distinction between header and footer ?
+/** describes properties that control the formatting of headers and
+ footers for documents that do not allow individual settings for
+ individual parts like pages or slides.
+ */
+published service HeaderFooterSettings
+{
+ /** gives access to the properties implemented by this service.
+ */
+ interface com::sun::star::beans::XPropertySet;
+
+
+ /** enables or disables the printing of the page name in the
+ header or footer
+ */
+ [optional, property] boolean IsPrintPageName;
+
+ /** enables or disables the printing of the date in the
+ header or footer
+ */
+ [optional, property] boolean IsPrintDate;
+
+ /** enables or disables the printing of the current time in the
+ header or footer
+ */
+ [optional, property] boolean IsPrintTime;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/ImportFilter.idl b/offapi/com/sun/star/document/ImportFilter.idl
new file mode 100644
index 000000000..a6079f461
--- /dev/null
+++ b/offapi/com/sun/star/document/ImportFilter.idl
@@ -0,0 +1,112 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_ImportFilter_idl__
+#define __com_sun_star_document_ImportFilter_idl__
+
+#include <com/sun/star/document/XImporter.idl>
+#include <com/sun/star/document/XFilter.idl>
+#include <com/sun/star/lang/XInitialization.idl>
+#include <com/sun/star/container/XNamed.idl>
+
+
+module com { module sun { module star { module document {
+
+/** filter for imports
+
+ <p>
+ Such filters can be used for importing a content.
+ Of course it's possible to combine it with the service ExportFilter
+ if export functionality should be available at same implementation too.
+ </p>
+
+ @see ExportFilter
+ */
+published service ImportFilter
+{
+ /** set target(!) document for this filter
+
+ <p>
+ The document must be used as the target of the filter.
+ Any external content will be written there.
+ </p>
+ */
+ interface XImporter;
+
+ /** filter interface
+
+ <p>
+ It's used to filter a document at loading time.
+ The target document should be already set by using another interface
+ ImportFilter::XImporter which is supported by this service too.
+ </p>
+
+ <p>
+ Tip:<br>
+ If same implementation provides the service ExportFilter too,
+ code must distinguish between filtering into a target document (for import) or
+ filtering from a source document (for export). This can be recognized by saving
+ state of used interfaces XExporter or XImporter!
+ Otherwise it's not clear which action is required here.
+ </p>
+ */
+ interface XFilter;
+
+ /** support initialization of filter with its own configuration
+
+ <p>
+ A filter object must be created by global service FilterFactory.
+ If filter supports this optional interface, he will be initialized by the factory directly
+ after creation. The factory will pass follow information to this new instance:
+ <ul>
+ <li>first item will be a set of configuration data of the filter</li>
+ <li>after that will follow may given optional parameters of call
+ com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments()
+ of service FilterFactory.
+ </li>
+ </ul>
+ See description of service FilterFactory::XNameContainer for a description of
+ possible configuration data.
+ </p>
+ */
+ [optional] interface com::sun::star::lang::XInitialization;
+
+ /** provides access to the internal name of this filter
+
+ <p>
+ This internal filter name can be used on service FilterFactory
+ to get further information about it (e.g. his registration for mime types or extensions etc.)
+ It's important that returned string is the "internal name" of the filter which must be
+ unambiguous against all other registered filters in current installation.
+ </p>
+ <p>
+ <strong>Attention!</strong><br>
+ Supported method setName() should be ignored or forwarded to the FilterFactory.
+ It's not allowed to set it directly to the configuration. Because it depends
+ from real implementation of the FilterFactory if it will be allowed or not!
+ </p>
+ */
+ [optional] interface com::sun::star::container::XNamed;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/IndexedPropertyValues.idl b/offapi/com/sun/star/document/IndexedPropertyValues.idl
new file mode 100644
index 000000000..e9b96febd
--- /dev/null
+++ b/offapi/com/sun/star/document/IndexedPropertyValues.idl
@@ -0,0 +1,37 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_IndexedPropertyValues_idl__
+#define __com_sun_star_document_IndexedPropertyValues_idl__
+
+#include <com/sun/star/container/XIndexContainer.idl>
+
+
+module com { module sun { module star { module document {
+
+/**
+ @since LibreOffice 4.1
+ */
+service IndexedPropertyValues : com::sun::star::container::XIndexContainer;
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/LinkTarget.idl b/offapi/com/sun/star/document/LinkTarget.idl
new file mode 100644
index 000000000..be5b9cc43
--- /dev/null
+++ b/offapi/com/sun/star/document/LinkTarget.idl
@@ -0,0 +1,55 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_LinkTarget_idl__
+#define __com_sun_star_document_LinkTarget_idl__
+
+#include <com/sun/star/beans/XPropertySet.idl>
+
+#include <com/sun/star/document/XLinkTargetSupplier.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** This service is implemented by objects inside a document object model that
+ can be the target of a link inside a document
+ */
+published service LinkTarget
+{
+ interface com::sun::star::beans::XPropertySet;
+
+ /** a link target may have child objects which can be link targets too.
+ These are accessible by this optional interface.
+ */
+ [optional] interface com::sun::star::document::XLinkTargetSupplier;
+
+ /** contains a human readable name for this object that could be displayed in a user
+ interface.
+ */
+ [readonly, property] string LinkDisplayName;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/LinkTargets.idl b/offapi/com/sun/star/document/LinkTargets.idl
new file mode 100644
index 000000000..015133566
--- /dev/null
+++ b/offapi/com/sun/star/document/LinkTargets.idl
@@ -0,0 +1,47 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_LinkTargets_idl__
+#define __com_sun_star_document_LinkTargets_idl__
+
+#include <com/sun/star/container/XNameAccess.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** This service gives access to a collection of names that are child links
+ of the parent object that supplied this service.
+
+ <p>The com::sun::star::container::XNameAccess returns elements
+ of com::sun::star::beans::XPropertySet that implement
+ the service LinkTarget. </p>
+ */
+published service LinkTargets
+{
+ interface com::sun::star::container::XNameAccess;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/LinkUpdateModes.idl b/offapi/com/sun/star/document/LinkUpdateModes.idl
new file mode 100644
index 000000000..f1cdd93be
--- /dev/null
+++ b/offapi/com/sun/star/document/LinkUpdateModes.idl
@@ -0,0 +1,52 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_LinkUpdateModes_idl__
+#define __com_sun_star_document_LinkUpdateModes_idl__
+
+
+module com { module sun { module star { module document {
+
+
+published constants LinkUpdateModes
+{
+ /** never update links
+ */
+ const long NEVER = 0;
+
+ /** update links when confirmed on request during loading the
+ document
+ */
+ const long MANUAL = 1;
+
+ /** automatic update on load
+ */
+ const long AUTO = 2;
+
+ /** use the setting that is configured in your installed
+ application. This may be one of the above behaviors.
+ */
+ const long GLOBAL_SETTING = 3;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/LockFileCorruptRequest.idl b/offapi/com/sun/star/document/LockFileCorruptRequest.idl
new file mode 100644
index 000000000..4a22f0a96
--- /dev/null
+++ b/offapi/com/sun/star/document/LockFileCorruptRequest.idl
@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_LockFileCorruptRequest_idl__
+#define __com_sun_star_document_LockFileCorruptRequest_idl__
+
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/frame/XModel.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle to query user's decision
+ when the lock file is corrupt.
+
+ @since LibreOffice 6.0
+*/
+exception LockFileCorruptRequest : ::com::sun::star::io::IOException
+{
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/LockFileIgnoreRequest.idl b/offapi/com/sun/star/document/LockFileIgnoreRequest.idl
new file mode 100644
index 000000000..e7a015f3f
--- /dev/null
+++ b/offapi/com/sun/star/document/LockFileIgnoreRequest.idl
@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_LockFileIgnoreRequest_idl__
+#define __com_sun_star_document_LockFileIgnoreRequest_idl__
+
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/frame/XModel.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle to query user decision regarding storing
+ to a location where no lock file can be created.
+
+ @since OOo 3.0
+*/
+published exception LockFileIgnoreRequest : ::com::sun::star::io::IOException
+{
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/LockedDocumentRequest.idl b/offapi/com/sun/star/document/LockedDocumentRequest.idl
new file mode 100644
index 000000000..3039cc26b
--- /dev/null
+++ b/offapi/com/sun/star/document/LockedDocumentRequest.idl
@@ -0,0 +1,50 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_LockedDocumentRequest_idl__
+#define __com_sun_star_document_LockedDocumentRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/frame/XModel.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle to query user decision regarding locked document.
+
+ @since OOo 3.0
+*/
+published exception LockedDocumentRequest : ::com::sun::star::uno::Exception
+{
+ /** The URL of the locked document.
+ */
+ string DocumentURL;
+
+ /** The user information of the locked document.
+ */
+ string UserInfo;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/LockedOnSavingRequest.idl b/offapi/com/sun/star/document/LockedOnSavingRequest.idl
new file mode 100644
index 000000000..8285e9542
--- /dev/null
+++ b/offapi/com/sun/star/document/LockedOnSavingRequest.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_LockedOnSavingRequest_idl__
+#define __com_sun_star_document_LockedOnSavingRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/frame/XModel.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle to query user decision regarding locked
+ document on saving.
+
+ @since OOo 3.1
+*/
+published exception LockedOnSavingRequest : ::com::sun::star::uno::Exception
+{
+ /** The URL of the locked document.
+ */
+ string DocumentURL;
+
+ /** The user information of the locked document.
+ */
+ string UserInfo;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/MacroExecMode.idl b/offapi/com/sun/star/document/MacroExecMode.idl
new file mode 100644
index 000000000..14bc0b7a7
--- /dev/null
+++ b/offapi/com/sun/star/document/MacroExecMode.idl
@@ -0,0 +1,113 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_MacroExecMode_idl__
+#define __com_sun_star_document_MacroExecMode_idl__
+
+
+module com { module sun { module star { module document {
+
+/** Specify whether a macro can be executed.
+
+ @since OOo 1.1.2
+*/
+published constants MacroExecMode
+{
+ /** A macro should not be executed at all.
+ */
+
+ const short NEVER_EXECUTE = 0;
+
+ /** Execute macros from secure list quietly.
+
+ <p>
+ If a macro is not in the list a confirmation for it executing will
+ appear.
+ </p>
+ */
+
+ const short FROM_LIST = 1;
+
+ /** Execute any macro, macros signed with trusted certificates and macros
+ from secure list are executed quietly.
+
+ <p>
+ If the macro is neither in secure list nor signed a conformation
+ will be requested.
+ </p>
+ */
+
+ const short ALWAYS_EXECUTE = 2;
+
+ /** Use configuration to retrieve macro settings. In case a user
+ confirmation is required a dialog is output.
+ */
+
+ const short USE_CONFIG = 3;
+
+
+ /** A macro should be executed always no conformation should be provided.
+ */
+
+ const short ALWAYS_EXECUTE_NO_WARN = 4;
+
+ /** Use configuration to retrieve macro settings. Treat cases when user
+ confirmation required as rejected.
+ */
+
+ const short USE_CONFIG_REJECT_CONFIRMATION = 5;
+
+ /** Use configuration to retrieve macro settings. Treat cases when user
+ confirmation required as approved.
+ */
+
+ const short USE_CONFIG_APPROVE_CONFIRMATION = 6;
+
+ /** Execute only macros from secure list. Macros that are not from the list
+ are not executed.
+ */
+ const short FROM_LIST_NO_WARN = 7;
+
+ /** Execute only macros from secure list or macros that are signed by
+ trusted certificates.
+
+ <p> If the macro is neither in secure list nor signed it will not be
+ executed.
+ </p>
+
+ <p> If the macro is signed with unknown certificate a warning will
+ appear. The macro either will not be executed or if the warning
+ allows conformation, it will be executed after user agrees.
+ </p>
+ */
+ const short FROM_LIST_AND_SIGNED_WARN = 8;
+
+ /** Execute only macros from secure list or macros that are signed by
+ trusted certificates. No warning/conformation should be shown.
+ */
+ const short FROM_LIST_AND_SIGNED_NO_WARN = 9;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl
new file mode 100644
index 000000000..73ea2cacb
--- /dev/null
+++ b/offapi/com/sun/star/document/MediaDescriptor.idl
@@ -0,0 +1,619 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_MediaDescriptor_idl__
+#define __com_sun_star_document_MediaDescriptor_idl__
+
+#include <com/sun/star/io/XOutputStream.idl>
+#include <com/sun/star/io/XInputStream.idl>
+#include <com/sun/star/awt/Rectangle.idl>
+#include <com/sun/star/beans/NamedValue.idl>
+#include <com/sun/star/util/URL.idl>
+#include <com/sun/star/task/XInteractionHandler.idl>
+#include <com/sun/star/task/XStatusIndicator.idl>
+#include <com/sun/star/frame/XFrame.idl>
+
+
+module com { module sun { module star { module document {
+
+/** describes properties of a document, regarding the relationship
+ between the loaded document and the resource the document is
+ loaded from / stored to.
+
+ <p>
+ This service may be represented by a com::sun::star::beans::PropertyValue[].
+ Such descriptors will be passed to different functions, included into possible
+ load/save processes. Every member of such process can use this descriptor
+ and may change it if to actualize the information about the document.
+ So this descriptor should be used as an in/out parameter.
+ </p>
+
+ <p>
+ Note:<br>
+ It's not allowed to hold member of this descriptor by references longer than they
+ will be used (especially a possible stream). It's allowed to use it directly
+ or by copying it only.
+ </p>
+
+ @see com::sun::star::beans::PropertyValue
+ */
+service MediaDescriptor
+{
+ /** May be set by filters or detection services if user has chosen to
+ abort loading/saving, e.g. while entering a password.
+ */
+ [optional,property] boolean Aborted;
+
+ /** document is a template
+
+ <p>
+ Loading a component of type "template" creates a new untitled document
+ by default, but setting the "AsTemplate" property to `FALSE` loads the
+ template document for editing. Setting "AsTemplate" to `TRUE` creates a
+ new untitled document out of the loaded document, even if it has not
+ a "template" type.
+ </p>
+ */
+ [optional,property] boolean AsTemplate;
+
+ /** the author of the document
+
+ <p>
+ Only for storing versions in components supporting versioning:
+ author of version.
+ </p>
+ */
+ [optional,property] string Author;
+
+ /** identifier of used character set
+
+ <p>
+ Defines the character set for document formats that contain single
+ byte characters (if necessary).
+ </p>
+ */
+ [optional,property] string CharacterSet;
+
+ /** description of document
+
+ <p>
+ Only for storing versions in components supporting versioning:
+ comment (description) for stored version.
+ </p>
+ */
+ [optional,property] string Comment;
+
+ /** pack specific properties of caller
+
+ <p>
+ This is a parameter that can be used for any properties specific
+ for a special component type. Format of that depends from real
+ type of addressed component.
+ </p>
+
+ <p>
+ For extensibility, it is recommended to use values of type
+ sequence<com.sun.star.beans.NamedValue> with this property.
+ </p>
+ */
+ [optional,property] any ComponentData;
+
+ /** The base URL of the document to be used to resolve relative links.
+ */
+ [optional,property] string DocumentBaseURL;
+
+ /** document title
+
+ <p>
+ This parameter can be used to specify a title for a document.
+ </p>
+ */
+ [optional,property] string DocumentTitle;
+
+ /** encryption information for encryption/decryption of documents
+
+ <p>
+ It contains the necessary information for encryption/decryption of
+ a component (if necessary).
+ If neither password nor encryption data is specified, loading of
+ a password protected document will fail, storing will be done without
+ encryption. If both are provided, the encryption data is used
+ ( if the filter supports it ).
+ </p>
+ <p>
+ The encryption data is generated based on the password.
+ </p>
+ */
+ [optional,property] sequence< ::com::sun::star::beans::NamedValue > EncryptionData;
+
+ /** same as MediaDescriptor::URL
+
+ <p>
+ It will be supported for compatibility reasons only.
+ </p>
+
+ @deprecated
+ */
+ [optional,property] string FileName;
+
+ /** internal filter name
+
+ <p>
+ Name of a filter that should be used for loading or storing the component.
+ Names must match the names of the TypeDetection configuration,
+ invalid names are ignored. If a name is specified on loading,
+ it still will be verified by a filter detection, but in case of doubt
+ it will be preferred.
+
+ See this page for a list of internal filter names: https://help.libreoffice.org/latest/en-US/text/shared/guide/convertfilters.html
+ </p>
+ */
+ [optional,property] string FilterName;
+
+ /** same as MediaDescriptor::FilterOptions
+
+ <p>
+ It will be supported for compatibility reasons only.
+ </p>
+
+ @deprecated
+ */
+ [optional,property] string FilterFlags;
+
+ /** additional properties for filter
+
+ <p>
+ Some filters need additional parameters; use only together with property
+ MediaDescriptor::FilterName. Details must be documented
+ by the filter. This is an old format for some filters. If a string is not
+ enough, filters can use the property MediaDescriptor::FilterData.
+ </p>
+ */
+ [optional,property] string FilterOptions;
+
+ /** additional properties for filter
+
+ <p>
+ This is a parameter that can be used for any properties specific
+ for a special filter type. It should be used if
+ MediaDescriptor::FilterOptions isn't enough.
+ </p>
+ */
+ [optional,property] any FilterData;
+
+ /** load document invisible
+
+ <p>
+ Defines if the loaded component is made visible. If this property is not
+ specified, the component is made visible by default.
+ </p>
+ */
+ [optional,property] boolean Hidden;
+
+ /** The hierarchical path to the embedded document from topmost container.
+ */
+ [optional,property] string HierarchicalDocumentName;
+
+ /** a stream to receive the document data.
+
+ <p>
+ If used when storing a document: writing must be done using this stream.
+ If no stream is provided, the loader will create a stream by itself using
+ the other properties. It is not allowed to keep a reference to this
+ OutputStream after storing the component.
+ </p>
+ */
+ [optional,property] com::sun::star::io::XOutputStream OutputStream;
+
+ /** content of document
+
+ <p>
+ If used when loading a document: reading must be done using this stream.
+ If no stream is provided, the loader will create a stream by itself using
+ the other properties. It is not allowed to keep a reference to this
+ InputStream after loading the component, and it would be useless, because
+ in general an InputStream is usable for reading only once, except when it
+ also implements the com::sun::star::io::XSeekable interface.
+ </p>
+ */
+ [optional,property] com::sun::star::io::XInputStream InputStream;
+
+ /** handle exceptional situations
+
+ <p>
+ Object implementing the com::sun::star::task::InteractionHandler
+ service that is used to handle exceptional situations where proceeding with the task
+ is impossible without additional information or impossible at all.
+ The implemented API provides a default implementation for it that can handle many situations.
+ If no InteractionHandler is set, a suitable exception is thrown.
+ It is not allowed to keep a reference to this object, even not in the loaded
+ or stored component's copy of the MediaDescriptor provided by its arguments attribute.
+ </p>
+ */
+ [optional,property] com::sun::star::task::XInteractionHandler InteractionHandler;
+
+ /** jump to a marked position after loading
+
+ <p>
+ This is the same as the text behind a "#" in a http URL. But
+ this syntax with a "#" is not specified in most URL schemas.
+ </p>
+ */
+ [optional,property] string JumpMark;
+
+ /** specify mime type of content
+
+ <p>
+ Type of the medium to load, that must match to one of the types defined
+ in the TypeDetection configuration (otherwise it's ignored).
+ This bypasses the type detection of the com::sun::star::frame::Desktop environment,
+ so passing a wrong MediaType will cause failure of loading.
+ </p>
+ */
+ [optional,property] string MediaType;
+
+ /** please use the corresponding parameters of this descriptor instead
+
+ <p>
+ String that summarizes some flags for loading. The string contains capital
+ letters for the flags:<br>
+ <table border=1>
+ <tr>
+ <td><strong>flag</strong></td>
+ <td><strong>value</strong></td>
+ <td><strong>replacement</strong></td>
+ </tr>
+ <tr>
+ <td><em>ReadOnly</em></td>
+ <td>R</td>
+ <td>MediaDescriptor::ReadOnly</td>
+ </tr>
+ <tr>
+ <td><em>Preview</em></td>
+ <td>B</td>
+ <td>MediaDescriptor::Preview</td>
+ </tr>
+ <tr>
+ <td><em>AsTemplate</em></td>
+ <td>T</td>
+ <td>MediaDescriptor::AsTemplate</td>
+ </tr>
+ <tr>
+ <td><em>Hidden</em></td>
+ <td>H</td>
+ <td>MediaDescriptor::Hidden</td>
+ </tr>
+ </table>
+ </p>
+
+ @deprecated
+ */
+ [optional,property] string OpenFlags;
+
+ /** opens a new view for an already loaded document
+
+ <p>
+ Setting this to `TRUE` forces the component to create a new window on loading
+ in any case. If the component supports multiple views, a second view is
+ opened, if not, the component is loaded one more time. Otherwise the behavior
+ depends on the default window handling of the com::sun::star::frame::Desktop environment.
+ </p>
+ */
+ [optional,property] boolean OpenNewView;
+
+
+ /** overwrite any existing file
+
+ <p>
+ For storing only: overwrite any existing file, default is `TRUE`.
+ Setting this to `FALSE` raises an error, if the target file already exists.
+ </p>
+ */
+ [optional,property] boolean Overwrite;
+
+ /** password for loading or storing documents
+
+ <p>
+ It contains a password for loading or storing a component (if necessary).
+ If neither password nor encryption data is specified, loading of
+ a password protected document will fail, storing will be done without
+ encryption. If both are provided, the encryption data is used
+ ( if the filter supports it ).
+ </p>
+ */
+ [optional,property] string Password;
+
+ /** contains the data for HTTP post method as a sequence of bytes.
+
+ <p>
+ Data to send to a location described by the media descriptor to get
+ a result in return that will be loaded as a component
+ (usually in webforms). Default is: no PostData.
+ </p>
+ */
+ [optional,property] sequence< byte > PostData;
+
+ /** add loaded document to recent document list
+
+ <p>
+ Setting this to `FALSE` prevents the loaded document to be added to the recent documents list.
+ Default is `TRUE`.
+ </p>
+
+ @since LibreOffice 5.1
+ */
+ [optional,property] boolean PickListEntry;
+
+ /** use MediaDescriptor::PostData instead of this
+
+ <p>
+ Same as PostData, but the data is transferred as a string
+ (just for compatibility).
+ </p>
+
+ @deprecated
+ */
+ [optional,property] string PostString;
+
+ /** show preview
+
+ <p>
+ Setting this to `TRUE` tells the a loaded component that it is loaded as
+ a preview, so it can optimize loading and viewing for this special purpose.
+ Default is `FALSE`.
+ </p>
+ */
+ [optional,property] boolean Preview;
+
+ /** open document readonly
+
+ <p>
+ Tells whether a document should be loaded in a (logical) readonly or in
+ read/write mode. If opening in the desired mode is impossible, an error occurs.
+ By default the loaded content decides what to do: if its UCB content supports
+ a "readonly" property, the logical open mode depends on that, otherwise
+ it will be read/write. This is only a UI related property, opening a
+ document in read only mode will not prevent the component from being
+ modified by API calls, but all modifying functionality in the UI will
+ be disabled or removed.
+ </p>
+ */
+ [optional,property] boolean ReadOnly;
+
+ /** start presentation from a document
+
+ <p>
+ Tells the component loading the document that a presentation that is in the
+ document is to be started right away.
+ </p>
+ */
+ [optional,property] boolean StartPresentation;
+
+ /** name of document referrer
+
+ <p>
+ A URL describing the environment of the request; e.g. a referrer may be a
+ URL of a document, if a hyperlink inside this document is clicked to load
+ another document. The referrer may be evaluated by the addressed UCB content
+ or the loaded document. Without a referrer the processing of URLs that
+ needs security checks will be denied, e.g. "macro:" URLs.
+ <br>
+ Don't be confused about the wrong spelling; it is kept for compatibility reasons.
+ </p>
+ */
+ [optional,property] string Referer;
+
+ /** let the document be opened in repair mode
+
+ <p>
+ For loading of corrupted zip packages: Setting this to `TRUE` let the document
+ be opened in repair mode, so as much as possible information will be retrieved.
+ </p>
+
+ @since OOo 1.1.2
+ */
+ [optional,property] boolean RepairPackage;
+
+ /** can be used for status information
+
+ <p>
+ Object implementing the com::sun::star::task::XStatusIndicator
+ interface that can be used to give status information (text or progress) for the task.
+ The office provides a default implementation for it. It is not allowed to keep
+ a reference to this object, even not in the loaded or stored component's
+ copy of the MediaDescriptor provided by its arguments attribute.
+ </p>
+ */
+ [optional,property] com::sun::star::task::XStatusIndicator StatusIndicator;
+
+ /** allows to specify the URL that is used next time SaveAs dialog is opened
+
+ <p>
+ If the parameter is specified, the URL will be used by SaveAs dialog
+ next time as target folder.
+ </p>
+ */
+ [optional,property] string SuggestedSaveAsDir;
+
+ /** allows to specify the suggested file name that is used next time SaveAs
+ dialog is opened
+
+ <p>
+ If the parameter is specified, the file name will be suggested by
+ SaveAs dialog next time.
+ </p>
+ */
+ [optional,property] string SuggestedSaveAsName;
+
+ /** name of the template instead of the URL
+
+ <p>
+ The logical name of a template to load. Together with the MediaDescriptor::TemplateRegion
+ property it can be used instead of the URL of the template. Use always in conjunction with
+ MediaDescriptor::TemplateRegionName.
+ </p>
+ */
+ [optional,property] string TemplateName;
+
+ /** name of the template instead of the URL
+
+ <p>
+ See MediaDescriptor::TemplateName. The template region names are the folder names you see
+ in the templates dialog.
+ </p>
+ */
+ [optional,property] string TemplateRegionName;
+
+ /** regulate using of compressing
+
+ <p>
+ For storing: Setting this to `TRUE` means, don't use a zip file to save
+ the document, use a folder instead (only usable for UCB contents, that
+ support folders). Default is `FALSE`.
+ </p>
+ */
+ [optional,property] boolean Unpacked;
+
+ /** URL of the document
+
+ <p>
+ The location of the component in URL syntax. It must be a fully qualified URL.
+ </p>
+ */
+ [optional,property] string URL;
+
+ /** storage version
+
+ <p>
+ For components supporting versioning: the number of the version to be
+ loaded or saved. Default is zero and means: no version is created or
+ loaded, the "main" document is processed.
+ </p>
+ */
+ [optional,property] short Version;
+
+ /** set special view state
+ <p>
+ Data to set a special view state after loading. The type depends on
+ the component and is usually retrieved from a com::sun::star::frame::Controller
+ object by its com::sun::star::frame::XController
+ interface. Default is: no view data.
+ </p>
+ */
+ [optional,property] any ViewData;
+
+ /** id of the initial view
+
+ <p>
+ For components supporting different views: a number to define the view
+ that should be constructed after loading. Default is: zero, and this
+ should be treated by the component as the default view.
+ </p>
+ */
+ [optional,property] short ViewId;
+
+ /** should the macro be executed.
+ the value should be one from com::sun::star::document::MacroExecMode
+ constant list.
+
+ @since OOo 1.1.2
+ */
+ [optional,property] short MacroExecutionMode;
+
+ /** can the document be updated depending from links.
+ the value should be one from com::sun::star::document::UpdateDocMode
+ constant list.
+
+ @since OOo 1.1.2
+ */
+ [optional,property] short UpdateDocMode;
+
+ /** specifies the name of the view controller to create when loading a document
+
+ <p>If this property is used when loading a document into a frame, then it
+ specifies the name of the view controller to create. That is, the property
+ is passed to the document's com::sun::star::frame::XModel2::createViewController()
+ method.<br/>
+ If the loaded document does not support the <code>XModel2</code> interface,
+ the property is ignored.</p>
+
+ @see ::com::sun::star::frame::XModel2::createViewController
+ @see ::com::sun::star::frame::XController2::ViewControllerName
+
+ @since OOo 3.0
+ */
+ [optional,property] string ViewControllerName;
+
+ /** specifies the frame containing the document. May be empty.
+ */
+ [optional,property] com::sun::star::frame::XFrame Frame;
+
+ /** Setting this option will prevent copying/dragging any content anywhere.
+ The commands 'Copy' and 'Cut' will be disabled; selection clipboard won't work,
+ and dragging with mouse will also be disabled.
+
+ @since LibreOffice 6.4
+ */
+ [optional,property] boolean LockContentExtraction;
+
+ /** Setting this option will prevent exporting document content to any file.
+ Export, Send, save as, etc will be disabled,
+ as well as individual graphic/chart export and mail merge.
+
+ @since LibreOffice 6.4
+ */
+ [optional,property] boolean LockExport;
+
+ /** Setting this option will disable all print functions (including Printer setup)
+
+ @since LibreOffice 6.4
+ */
+ [optional,property] boolean LockPrint;
+
+ /** Setting this option will disable the save function.
+ *
+ @since LibreOffice 6.4
+ */
+ [optional,property] boolean LockSave;
+
+ /** Setting this option will disable switching to edit mode from read-only mode.
+ *
+ @since LibreOffice 6.4
+ */
+ [optional,property] boolean LockEditDoc;
+
+ /** Mark the document as replaceable / a placeholder
+
+ <p>Normally a document is always opened in a new frame. If this property is
+ set to true, this document just acts as a placeholder while it's unmodified.
+ I.e. the next opened document from its frame will close and replace it.</p>
+
+ <p>This defaults to false, except for the default template of a LibreOffice
+ module, referenced as "private:factory/&lt;module&gt;".</p>
+
+ @since LibreOffice 7.0
+ */
+ [optional,property] boolean Replaceable;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/NamedPropertyValues.idl b/offapi/com/sun/star/document/NamedPropertyValues.idl
new file mode 100644
index 000000000..08b0035cd
--- /dev/null
+++ b/offapi/com/sun/star/document/NamedPropertyValues.idl
@@ -0,0 +1,37 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_NamedPropertyValues_idl__
+#define __com_sun_star_document_NamedPropertyValues_idl__
+
+#include <com/sun/star/container/XNameContainer.idl>
+
+
+module com { module sun { module star { module document {
+
+/**
+ @since LibreOffice 4.1
+ */
+service NamedPropertyValues : com::sun::star::container::XNameContainer;
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/NoSuchFilterRequest.idl b/offapi/com/sun/star/document/NoSuchFilterRequest.idl
new file mode 100644
index 000000000..cafedad74
--- /dev/null
+++ b/offapi/com/sun/star/document/NoSuchFilterRequest.idl
@@ -0,0 +1,57 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_NoSuchFilterRequest_idl__
+#define __com_sun_star_document_NoSuchFilterRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+
+
+module com { module sun { module star { module document {
+
+/** should be used for interaction to handle states of unknown filter during detection
+
+ <p>
+ If during loading time the filter can't be detected and wasn't given at calling time,
+ a possible com::sun::star::task::InteractionHandler will be used.
+ (it's a part of used MediaDescriptor)
+ Such "NoSuchFilterRequest" will be used then to start right interaction on that to
+ get a decision which filter should be used for given URL. A possible continuation
+ of type XInteractionFilterSelect will transport this decision back to
+ generic filter detection and force using of it. Of course it's possible to abort
+ the loading process by use another continuation com::sun::star::task::XInteractionAbort.
+ </p>
+
+ @see MediaDescriptor
+ @see com::sun::star::task::InteractionHandler
+ @see XInteractionFilterSelect
+ @see com::sun::star::task::XInteractionAbort
+*/
+published exception NoSuchFilterRequest : ::com::sun::star::uno::Exception
+{
+ /** transport URL which couldn't be detected
+ */
+ string URL;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/OOXMLDocumentPropertiesImporter.idl b/offapi/com/sun/star/document/OOXMLDocumentPropertiesImporter.idl
new file mode 100644
index 000000000..04299af95
--- /dev/null
+++ b/offapi/com/sun/star/document/OOXMLDocumentPropertiesImporter.idl
@@ -0,0 +1,37 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_OOXMLDocumentPropertiesImporter_idl__
+#define __com_sun_star_document_OOXMLDocumentPropertiesImporter_idl__
+
+#include <com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** allows to import document properties from OOXML format
+ */
+service OOXMLDocumentPropertiesImporter : XOOXMLDocumentPropertiesImporter;
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl
new file mode 100644
index 000000000..e9dd418ab
--- /dev/null
+++ b/offapi/com/sun/star/document/OfficeDocument.idl
@@ -0,0 +1,176 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_OfficeDocument_idl__
+#define __com_sun_star_document_OfficeDocument_idl__
+
+#include <com/sun/star/frame/XModel.idl>
+#include <com/sun/star/util/XModifiable.idl>
+#include <com/sun/star/frame/XStorable.idl>
+#include <com/sun/star/view/XPrintable.idl>
+#include <com/sun/star/view/XPrintJobBroadcaster.idl>
+#include <com/sun/star/document/XEventBroadcaster.idl>
+#include <com/sun/star/document/XEventsSupplier.idl>
+#include <com/sun/star/document/XViewDataSupplier.idl>
+#include <com/sun/star/document/XDocumentEventBroadcaster.idl>
+#include <com/sun/star/document/XEmbeddedScripts.idl>
+#include <com/sun/star/document/XDocumentPropertiesSupplier.idl>
+#include <com/sun/star/document/XUndoManagerSupplier.idl>
+
+
+module com { module sun { module star { module document {
+
+/** abstract service which specifies a storable and printable document
+
+ <p>
+ All major document-like components should support this service
+ instead of simple components which supports a com::sun::star::frame::Controller
+ or pure com::sun::star::awt::XWindow only.
+ </p>
+
+ @see com::sun::star::frame::Controller
+ */
+published service OfficeDocument
+{
+ /** represents a component which is created from a URL and arguments
+
+ <p>
+ It is a representation of a resource in the sense that it was
+ created/loaded from the resource. The arguments are passed to the loader
+ to modify its behavior.
+ </p>
+ */
+ interface com::sun::star::frame::XModel;
+
+ /** a storable document should provide information about his modify state
+
+ <p>
+ With this interface it's possible too, to reset the modify state.
+ That can be necessary to prevent code against problem during closing
+ of the document without saving any changes.
+ </p>
+ */
+ interface com::sun::star::util::XModifiable;
+
+ /** offers a simple way to store a component to a URL
+
+ <p>
+ This interface supports functionality
+ <ul>
+ <li>to make a copy of current component by saving it to another location</li>
+ <li>to commit made changes</li>
+ <li>to convert it by saving it by using suitable filter name.</li>
+ </ul>
+ </p>
+ */
+ interface com::sun::star::frame::XStorable;
+
+ /** offers a way to print a component
+
+ <p>
+ It's possible to specify which printer should be used and of course
+ print the document on it.
+ </p>
+ */
+ interface com::sun::star::view::XPrintable;
+
+ /** is an old and deprecated version of the XDocumentEventBroadcaster interface
+ @deprecated
+ */
+ [optional] interface XEventBroadcaster;
+
+ /** makes it possible to register listeners which are called whenever
+ a document event occurs
+ */
+ [optional] interface XDocumentEventBroadcaster;
+
+ /** access to bound event handlers
+ */
+ [optional] interface XEventsSupplier;
+
+ /** access to some properties describing all open views to a document
+ */
+ [optional] interface XViewDataSupplier;
+
+ /** allows for getting information about a print job
+
+ @since OOo 1.1.2
+ */
+ [optional] interface com::sun::star::view::XPrintJobBroadcaster;
+
+ /** is supported when the document can contain scripts and dialogs
+
+ @since OOo 2.4
+ */
+ [optional] interface XEmbeddedScripts;
+
+ /** access to the DocumentProperties.
+
+ @since OOo 3.0
+ */
+ [optional] interface XDocumentPropertiesSupplier;
+
+ /** provides access to the document's undo manager.
+ */
+ [optional] interface XUndoManagerSupplier;
+
+ /** controls the focus behavior of the form controls in the document
+
+ <p>
+ If this flag is set to `TRUE`, any view belonging to the document
+ should focus the first control in the document. With this, you may
+ control if your document works primarily as a form document.
+ </p>
+ */
+ [property, optional] boolean AutomaticControlFocus;
+
+ /** controls the initial (on-load) behavior of the form controls in the document
+
+ <p>If set to `TRUE`, upon loading the document, the form controls will be in design mode.<br/>
+ If set to `FALSE`, they will be alive, i.e. operational.<br/>
+ With this, you may control if your document works primarily as a form document.
+ </p>
+ */
+ [property, optional] boolean ApplyFormDesignMode;
+
+ /** contains a unique id for the document
+
+ <p>Once calculated, the id must not change until the document has been
+ closed. Upon closing it will not be made persistent. Thus, the document
+ may get a different id every time it gets loaded.</p>
+ */
+ [property, optional, readonly] string RuntimeUID;
+
+ /** Grab bag of document properties, used as a string-any map for
+ interim interop purposes.
+
+ @since LibreOffice 4.2
+
+ <p>This property is intentionally not handled by the ODF
+ filter. Any member that should be handled there should be
+ first moved out from this grab bag to a separate property.</p>
+ */
+ [optional, property] sequence<com::sun::star::beans::PropertyValue> InteropGrabBag;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/OleEmbeddedServerRegistration.idl b/offapi/com/sun/star/document/OleEmbeddedServerRegistration.idl
new file mode 100644
index 000000000..2cc11f326
--- /dev/null
+++ b/offapi/com/sun/star/document/OleEmbeddedServerRegistration.idl
@@ -0,0 +1,45 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_OleEmbeddedServerRegistration_idl__
+#define __com_sun_star_document_OleEmbeddedServerRegistration_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** registers embedded server for StarOffice documents
+ <p>
+ This service is only used to register embedded server support
+ for StarOffice documents.
+ </p>
+
+ @since OOo 1.1.2
+ */
+published service OleEmbeddedServerRegistration
+ : com::sun::star::uno::XInterface;
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/OwnLockOnDocumentRequest.idl b/offapi/com/sun/star/document/OwnLockOnDocumentRequest.idl
new file mode 100644
index 000000000..f805f2c4d
--- /dev/null
+++ b/offapi/com/sun/star/document/OwnLockOnDocumentRequest.idl
@@ -0,0 +1,54 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_OwnLockOnDocumentRequest_idl__
+#define __com_sun_star_document_OwnLockOnDocumentRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/frame/XModel.idl>
+
+
+module com { module sun { module star { module document {
+
+/** Is used for interaction handle to query user decision regarding locked
+ document.
+
+ @since OOo 3.1
+*/
+published exception OwnLockOnDocumentRequest : ::com::sun::star::uno::Exception
+{
+ /** The URL of the locked document.
+ */
+ string DocumentURL;
+
+ /** The time from which the document is locked.
+ */
+ string TimeInfo;
+
+ /** Whether the request is related to storing process
+ */
+ boolean IsStoring;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/PDFDialog.idl b/offapi/com/sun/star/document/PDFDialog.idl
new file mode 100644
index 000000000..398029fa9
--- /dev/null
+++ b/offapi/com/sun/star/document/PDFDialog.idl
@@ -0,0 +1,50 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_PDFDialog_idl__
+#define __com_sun_star_document_PDFDialog_idl__
+
+#include <com/sun/star/ui/dialogs/FilterOptionsDialog.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** This service is for a PDFDialog
+ */
+service PDFDialog
+{
+ service com::sun::star::ui::dialogs::FilterOptionsDialog;
+
+ /** PDFDialog options can be set as sequence of
+ com.sun.star.beans.PropertyValue at the FilterData property of the
+ MediaDescriptor. The PropertyValues which are supported within the
+ sequence are described in the registry at Office.Common/Filter/PDF/Export
+
+ The source of this registry can be found in following file:
+ "officecfg/registry/schema/org/openoffice/Office/Common.xcs"
+ */
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/PrinterIndependentLayout.idl b/offapi/com/sun/star/document/PrinterIndependentLayout.idl
new file mode 100644
index 000000000..989eaa7be
--- /dev/null
+++ b/offapi/com/sun/star/document/PrinterIndependentLayout.idl
@@ -0,0 +1,57 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_PrinterIndependentLayout_idl__
+#define __com_sun_star_document_PrinterIndependentLayout_idl__
+
+
+module com { module sun { module star { module document {
+
+
+/** specifies whether the document printer metric is used.
+
+ @since OOo 1.1.2
+*/
+published constants PrinterIndependentLayout
+{
+ /** use printer-dependent metrics for layout */
+ const short DISABLED = 1;
+
+ /** use printer-independent metrics for layout,
+ assuming a generic 600dpi printer */
+ const short LOW_RESOLUTION = 2;
+
+ /** @deprecated ENABLED changed to LOW_RESOLUTION,
+ to distinguish from HIGH_RESOLUTION */
+ const short ENABLED = LOW_RESOLUTION;
+
+ /** use printer-independent metrics for layout,
+ assuming a generic high-resolution printer (4800dpi) */
+ const short HIGH_RESOLUTION = 3;
+
+ /** [future:] use printer-independent-layout settings from parent object
+ const short LIKE_PARENT = 4;
+ */
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/RedlineDisplayType.idl b/offapi/com/sun/star/document/RedlineDisplayType.idl
new file mode 100644
index 000000000..750d0701a
--- /dev/null
+++ b/offapi/com/sun/star/document/RedlineDisplayType.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_RedlineDisplayType_idl__
+#define __com_sun_star_document_RedlineDisplayType_idl__
+
+
+module com { module sun { module star { module document {
+
+
+/** specifies which changes in a document are displayed.
+ */
+published constants RedlineDisplayType
+{
+ /** no changes are displayed.
+ */
+ const short NONE = 0;
+
+ /** only inserted parts are displayed and attributed.
+ */
+ const short INSERTED = 1;
+
+ /** only inserted parts are displayed and attributed.
+ */
+ const short INSERTED_AND_REMOVED = 2;
+
+ /** only removed parts are displayed and attributed.
+ */
+ const short REMOVED = 3;
+};
+
+};};};};
+#endif
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/ReloadEditableRequest.idl b/offapi/com/sun/star/document/ReloadEditableRequest.idl
new file mode 100644
index 000000000..f091bcf26
--- /dev/null
+++ b/offapi/com/sun/star/document/ReloadEditableRequest.idl
@@ -0,0 +1,50 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_ReloadEditableRequest_idl__
+#define __com_sun_star_document_ReloadEditableRequest_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+
+module com
+{
+ module sun
+ {
+ module star
+ {
+ module document
+ {
+ /** Is used for interaction handle to query user decision regarding reloading a
+ document that was recently made editable.
+
+ @since LibreOffice 7.2
+ */
+ published exception ReloadEditableRequest : ::com::sun::star::uno::Exception
+ {
+ /** The URL of the document that is open but was made editable.
+ */
+ string DocumentURL;
+ };
+ };
+ };
+ };
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */
diff --git a/offapi/com/sun/star/document/Settings.idl b/offapi/com/sun/star/document/Settings.idl
new file mode 100644
index 000000000..55ece20e5
--- /dev/null
+++ b/offapi/com/sun/star/document/Settings.idl
@@ -0,0 +1,293 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_Settings_idl__
+#define __com_sun_star_document_Settings_idl__
+
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/i18n/XForbiddenCharacters.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** describes properties that apply to the whole document of any
+ application.
+
+ <p>For application specific settings, please refer to the
+ individual services.</p>
+
+ @see com::sun::star::text::DocumentSettings
+ @see com::sun::star::sheet::DocumentSettings
+ @see com::sun::star::drawing::DocumentSettings
+ @see com::sun::star::presentation::DocumentSettings
+ */
+published service Settings
+{
+ /** gives access to the properties implemented by this service.
+ */
+ interface com::sun::star::beans::XPropertySet;
+
+
+ // Note: These settings are global. However there is a note at
+ // every property that shows which application currently makes use
+ // of it.
+
+ // Writer and Draw/Impress and Calc
+ /** gives access to the set of forbidden characters.
+
+ @return the
+ com::sun::star::i18n::XForbiddenCharacters
+ interface to allow retrieval and modification of the
+ forbidden characters set.
+ */
+ [optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters;
+
+ // Writer and Calc
+ /** specifies the update mode for links when loading text documents.
+
+ <p>For supported values see the constants group
+ LinkUpdateModes.</p>
+ */
+ [optional, property] short LinkUpdateMode;
+
+ // Writer and Draw/Impress and Calc
+ /** printer used by the document.
+ */
+ [property] string PrinterName;
+
+ // Writer and Draw/Impress and Calc
+ /** platform and driver dependent printer setup data.
+
+ <p>This property serves to capture the current printer setup
+ settings, such as paper tray, printer options, etc. The data
+ can typically be interpreted only by the system that generated
+ it. The PrinterSetup property may be used to save and restore
+ the user's printer settings.</p>
+ */
+ [property] sequence< byte > PrinterSetup;
+
+ // Writer and Draw/Impress and Calc
+ /** specifies if kerning is applied to Asian punctuation.
+
+ <p>Applies only if kerning is enabled.</p>
+ */
+ [optional, property] boolean IsKernAsianPunctuation;
+
+ // Writer and Draw/Impress and Calc
+ /** specifies the compression (character spacing) type used for
+ Asian characters.
+
+ @see com::sun::star::text::CharacterCompressionType
+ */
+ [optional, property] short CharacterCompressionType;
+
+ // Writer and Draw/Impress and Calc
+ /** specifies if the user-specific settings saved within a
+ document should be loaded with the document.
+ */
+ [optional, property] boolean ApplyUserData;
+
+ // Writer and Calc
+ /** specifies if a new version is created if a document has
+ been modified and you want to close it.
+ */
+ [optional, property] boolean SaveVersionOnClose;
+
+ // Writer and Draw/Impress and Calc
+ /** specifies if the document should be updated when the
+ template it was created from changes.
+
+ <p>Applies only for documents that were created from a template.</p>
+ */
+ [optional, property] boolean UpdateFromTemplate;
+
+ // Writer
+ /** specifies if fields in text documents are updated automatically.
+ */
+ [optional, property] boolean FieldAutoUpdate;
+
+ // Writer
+ /** The name of the globally registered
+ com::sun::star::sdb::DataSource
+ from which the current data is taken.
+
+ <p>The data source can e.g. be used for feeding a form
+ letter.</p>
+ */
+ [optional, property] string CurrentDatabaseDataSource;
+
+ // Writer
+ /** a string value, specifying the name of the object displayed
+ currently (or the SQL statement used).
+ */
+ [optional, property] string CurrentDatabaseCommand;
+
+ // Writer
+ // Note: What is the property DataTableName? Is this Writer-specific?
+ /** determines the interpretation of the property DataTableName.
+
+ @see com::sun::star::sdb::CommandType
+ */
+ [optional, property] long CurrentDatabaseCommandType;
+
+ // Draw and Impress
+ /**
+ */
+ [optional, property] long DefaultTabStop;
+
+ // Draw and Impress
+ /** determines if the document will be printed as a booklet
+ (brochure), i.e., two document pages are put together on one
+ physical page, such that you can fold the print result and get
+ a booklet.
+
+ <p>Note, that you have to print in duplex mode, if both,
+ #IsPrintBookletFront and
+ #IsPrintBookletBack are set to `TRUE`.</p>
+ */
+ [optional, property] boolean IsPrintBooklet;
+
+ // Draw and Impress
+ /** is only effective, if #IsPrintBooklet is
+ `TRUE`. If this property is also `TRUE`, only the fronts of
+ the pages of your booklet are printed.
+
+ <p>This is especially useful, if your printer does not supply
+ duplex printing.</p>
+ */
+ [optional, property] boolean IsPrintBookletFront;
+
+ // Draw and Impress
+ /** is only effective, if #IsPrintBooklet is
+ `TRUE`. If this property is also `TRUE`, only the backs of
+ the pages of your booklet are printed.
+
+ <p>This is especially useful, if your printer does not supply
+ duplex printing.</p>
+ */
+ [optional, property] boolean IsPrintBookletBack;
+
+ // Draw and Impress
+ /** how printing uses color.
+
+ <ul>
+ <li>0: Default</li>
+ <li>1: Grayscale</li>
+ <li>2: Black &amp; White (with grayscale images)</li>
+ </ul>
+ */
+ [optional, property] long PrintQuality;
+
+ // Draw and Impress
+ /** contains the URL that points to a color table (file extension
+ .soc) that will be used for showing a palette in dialogs using
+ colors.
+ */
+ [optional, property] string ColorTableURL;
+
+ // Draw and Impress
+ /**
+ */
+ [optional, property] string DashTableURL;
+
+ // Draw and Impress
+ /**
+ */
+ [optional, property] string LineEndTableURL;
+
+ // Draw and Impress
+ /**
+ */
+ [optional, property] string HatchTableURL;
+
+ // Draw and Impress
+ /**
+ */
+ [optional, property] string GradientTableURL;
+
+ // Draw and Impress
+ /**
+ */
+ [optional, property] string BitmapTableURL;
+
+ // Calc
+ /**
+ */
+ [optional, property] boolean AutoCalculate;
+
+ // Writer, later others
+ /** forbid use of printer metrics for layout
+
+ <p>For supported values see the constants group
+ PrinterIndependentLayout.</p>
+ */
+ [optional, property] short PrinterIndependentLayout;
+
+ // Writer, maybe later other applications, too
+ /** layout engine should add value of a Font's "external leading"
+ * attribute to the line spacing.
+ */
+ [optional, property] boolean AddExternalLeading;
+
+ // Writer, maybe later others
+ /**
+ Whether to embed fonts used by the document (see e.g. handling
+ of OOXML embedRegular etc.)
+ @since LibreOffice 4.0
+ */
+ [optional, property] boolean EmbedFonts;
+ // Writer, maybe later others
+ /**
+ Whether to embed also system fonts used by the document.
+ Does not have any effect if EmbedFonts is false.
+ @since LibreOffice 4.0
+ */
+ [optional, property] boolean EmbedSystemFonts;
+
+ /** Whether to embed only the fonts that are used in the document.
+
+ @since LibreOffice 6.2
+ */
+ [optional, property] boolean EmbedOnlyUsedFonts;
+
+ /** Whether to embed Latin script fonts.
+
+ @since LibreOffice 6.2
+ */
+ [optional, property] boolean EmbedLatinScriptFonts;
+
+ /** Whether to embed Asian script fonts.
+
+ @since LibreOffice 6.2
+ */
+ [optional, property] boolean EmbedAsianScriptFonts;
+
+ /** Whether to embed Complex script fonts.
+
+ @since LibreOffice 6.2
+ */
+ [optional, property] boolean EmbedComplexScriptFonts;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/TypeDetection.idl b/offapi/com/sun/star/document/TypeDetection.idl
new file mode 100644
index 000000000..57e446bc3
--- /dev/null
+++ b/offapi/com/sun/star/document/TypeDetection.idl
@@ -0,0 +1,173 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_TypeDetection_idl__
+#define __com_sun_star_document_TypeDetection_idl__
+
+#include <com/sun/star/document/XTypeDetection.idl>
+#include <com/sun/star/container/XNameContainer.idl>
+#include <com/sun/star/container/XContainerQuery.idl>
+#include <com/sun/star/util/XFlushable.idl>
+
+
+module com { module sun { module star { module document {
+
+/** encapsulate a type detection service and provide read/write access on it's configuration data.
+
+ <p>
+ It's possible to make a "flat" detection which may use internal configuration
+ data only - or a "deep" detection which use special ExtendedTypeDetection
+ services to look into the document stream. Last mode can be suppressed to perform the operation.
+ Of course the results can't be guaranteed then. (e.g. in case the extension was changed)
+ </p>
+ */
+published service TypeDetection
+{
+ /** can be used to make a flat or deep type detection.
+
+ <p>
+ Use this interface to get information about the type of the given resource.
+ Return value will be always an internal name of a registered document type.
+ It can be used may on other services (e.g. com::sun::star::frame::FrameLoaderFactory)
+ to do further things, which base on it (e.g. to load it into a frame).
+ </p>
+ */
+ interface XTypeDetection;
+
+ /** provides read access to the complete set of type configuration data.
+
+ <p>
+ Every container item is specified as a set of properties and will be
+ represented by a sequence< com::sun::star::beans::PropertyValue > structure.
+ Follow properties are supported:
+ (But note: not all of them must be present every time!)
+
+ <table border=1>
+ <tr>
+ <td><strong>Property Name</strong></td>
+ <td><strong>Value Type</strong></td>
+ <td><strong>Description</strong></td>
+ </tr>
+ <tr>
+ <td><em>Name</em></td>
+ <td>[string]</td>
+ <td>The internal name is the only value, which makes a container item unique.</td>
+ </tr>
+ <tr>
+ <td><em>UIName</em></td>
+ <td>[string]</td>
+ <td>It contains the localized name for this type for the current locale.</td>
+ </tr>
+ <tr>
+ <td><em>UINames</em></td>
+ <td>[sequence< string >]</td>
+ <td>It contains all available localized names for this type. The are organized
+ in pairs and represented as a structure of sequence< com::sun::star::beans::PropertyValue >.
+ The name of such property must be interpreted as locale; its value as the localized
+ type name corresponding to this locale.</td>
+ </tr>
+ <tr>
+ <td><em>MediaType</em></td>
+ <td>[string]</td>
+ <td>It contains the MIME or content type descriptor. The differences between a MIME type and
+ an internal type name was made, to resolve existing ambiguities.</td>
+ </tr>
+ <tr>
+ <td><em>ClipboardFormat</em><strong>deprecated!</strong></td>
+ <td>[string]</td>
+ <td>It was interpreted as an identifier inside clipboard.
+ Please use new property ContentFormat instead of this now.</td>
+ </tr>
+ <tr>
+ <td><em>ContentFormat</em></td>
+ <td>[string]</td>
+ <td>It's and identifier, which is used for a deep format detection.
+ An ExtendedTypeDetection use this value to match
+ a given content to this type. e.g. It's interpreted as the doc type
+ of an XML stream or as an identifier inside a file header.
+ </td>
+ </tr>
+ <tr>
+ <td><em>URLPattern</em></td>
+ <td>[sequence< string >]</td>
+ <td>This list contains different URL patterns, which identify this type.
+ E.g. data base contents can be described by a new defined protocol like "sql://select*".
+ In combination with a suitable com::sun::star::frame::FrameLoader or
+ ImportFilter/ExportFilter it would be possible then, to
+ layout a SQL query output into an office frame.</td>
+ </tr>
+ <tr>
+ <td><em>Extensions</em></td>
+ <td>[sequence< string >]</td>
+ <td>It contains a list of file extensions, which match this type.
+ They must be specified as pure extension, without any special signs.
+ E.g.: "doc", "html" ... but not ".doc".
+ Using wild cards is allowed but not very useful. They may result in
+ ambiguities with other type registrations can't be resolved anytime.</td>
+ </tr>
+ <tr>
+ <td><em>DocumentIconID</em></td>
+ <td>[integer]</td>
+ <td>It's an ID, which present the number of a corresponding icon.</td>
+ </tr>
+ </table>
+ </p>
+
+ <p>
+ Note:<br>
+ All elements of this container will be addressed by his internal name,
+ and it must be an unambiguous value.
+ </p>
+ */
+ interface com::sun::star::container::XNameAccess;
+
+ /** provides a write access to the configuration data.
+ */
+ [optional] interface com::sun::star::container::XNameContainer;
+
+ /** provides search on the configuration data set.
+
+ <p>
+ Against simple property search it provides some complex algorithms too.
+ For further information please read the SDK documentation.
+ </p>
+ */
+ [optional] interface com::sun::star::container::XContainerQuery;
+
+ /** can be used to perform container changes.
+
+ <p>
+ Because the complexness of such configuration set can be very high,
+ it seems not very useful to update the underlying configuration layer
+ on every container change request immediately. Another strategy can be to
+ make all changes (adding/changing/removing of items) and call flush at the end.
+ That will validate the whole container and reject inconsistent data sets.
+ Only in case all made changes was correct, they will be written back to the
+ configuration. Further this interface provides the possibility, that interested
+ changes listener can be registered too.
+ </p>
+ */
+ [optional] interface com::sun::star::util::XFlushable;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/UndoContextNotClosedException.idl b/offapi/com/sun/star/document/UndoContextNotClosedException.idl
new file mode 100644
index 000000000..29313e2a7
--- /dev/null
+++ b/offapi/com/sun/star/document/UndoContextNotClosedException.idl
@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_UndoContextNotClosedException_idl__
+#define __com_sun_star_document_UndoContextNotClosedException_idl__
+
+#include <com/sun/star/util/InvalidStateException.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** is thrown when an operation is attempted at an XUndoManager which requires all undo
+ contexts to be closed, but this requirement is not fulfilled.
+ @since OOo 3.4
+ */
+exception UndoContextNotClosedException : ::com::sun::star::util::InvalidStateException
+{
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/UndoFailedException.idl b/offapi/com/sun/star/document/UndoFailedException.idl
new file mode 100644
index 000000000..9c71dafc1
--- /dev/null
+++ b/offapi/com/sun/star/document/UndoFailedException.idl
@@ -0,0 +1,48 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_UndoFailedException_idl__
+#define __com_sun_star_document_UndoFailedException_idl__
+
+#include <com/sun/star/uno/Exception.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** thrown when reverting to re-applying an undoable action fails.
+
+ @see XUndoAction::undo
+ @see XUndoManager::undo
+ @since OOo 3.4
+ */
+exception UndoFailedException : ::com::sun::star::uno::Exception
+{
+ /** describes the reason why the operation failed. Usually, this member will carry an exception.
+ */
+ any Reason;
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/UndoManagerEvent.idl b/offapi/com/sun/star/document/UndoManagerEvent.idl
new file mode 100644
index 000000000..769e3ea1b
--- /dev/null
+++ b/offapi/com/sun/star/document/UndoManagerEvent.idl
@@ -0,0 +1,55 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_UndoManagerEvent_idl__
+#define __com_sun_star_document_UndoManagerEvent_idl__
+
+#include <com/sun/star/lang/EventObject.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** is an event sent by an XUndoManager implementation when the Undo/Redo stacks of the manager are
+ modified.
+ @see XUndoManager
+ @see XUndoManagerListener
+ @see XUndoAction
+ @since OOo 3.4
+ */
+struct UndoManagerEvent : ::com::sun::star::lang::EventObject
+{
+ /** the title of the undo action which is described by the event
+ @see XUndoAction::Title
+ */
+ string UndoActionTitle;
+
+ /** denotes the number of Undo contexts which are open, and not yet closed, at the time the event is fired.
+ @see XUndoManager::enterUndoContext
+ */
+ long UndoContextDepth;
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/UpdateDocMode.idl b/offapi/com/sun/star/document/UpdateDocMode.idl
new file mode 100644
index 000000000..c09187af1
--- /dev/null
+++ b/offapi/com/sun/star/document/UpdateDocMode.idl
@@ -0,0 +1,62 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_UpdateDocMode_idl__
+#define __com_sun_star_document_UpdateDocMode_idl__
+
+
+module com { module sun { module star { module document {
+
+/** Specify the way a document can be updated.
+
+ @since OOo 1.1.2
+*/
+published constants UpdateDocMode
+{
+ /** Do not update document.
+ */
+
+ const short NO_UPDATE = 0;
+
+ /** Update document if it does not require a dialog.
+ Otherwise do not update. For example a link to a database
+ can require a dialog to get password for an update.
+ */
+
+ const short QUIET_UPDATE = 1;
+
+ /** Produce update according to configuration settings.
+ If there are no settings use dialog.
+ */
+
+ const short ACCORDING_TO_CONFIG = 2;
+
+ /** Update document even if it does require a dialog.
+ */
+
+ const short FULL_UPDATE = 3;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XActionLockable.idl b/offapi/com/sun/star/document/XActionLockable.idl
new file mode 100644
index 000000000..f1bbb386c
--- /dev/null
+++ b/offapi/com/sun/star/document/XActionLockable.idl
@@ -0,0 +1,72 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XActionLockable_idl__
+#define __com_sun_star_document_XActionLockable_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** makes it possible to prevent object internal updates for a certain period
+ to be able to quickly change multiple parts of the objects, where the
+ updates would invalidate each other, anyway.
+ */
+published interface XActionLockable: com::sun::star::uno::XInterface
+{
+ /** @returns
+ `TRUE` if at least one lock exists.
+ */
+ boolean isActionLocked();
+
+ /** increments the lock count of the object by one.
+ */
+ void addActionLock();
+
+ /** decrements the lock count of the object by one.
+ */
+ void removeActionLock();
+
+ /** sets the locking level.
+
+ <p>This method is used for debugging purposes. The programming
+ environment can restore the locking after a break of a debug
+ session.</p>
+ */
+ void setActionLocks( [in] short nLock );
+
+ /** resets the locking level.
+
+ <p>This method is used for debugging purposes. The debugging
+ environment of a programming language can reset the locks
+ to allow refreshing of the view if a breakpoint is reached or
+ step execution is used. </p>
+ */
+ short resetActionLocks();
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XBinaryStreamResolver.idl b/offapi/com/sun/star/document/XBinaryStreamResolver.idl
new file mode 100644
index 000000000..0ebeabf22
--- /dev/null
+++ b/offapi/com/sun/star/document/XBinaryStreamResolver.idl
@@ -0,0 +1,69 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XBinaryStreamResolver_idl__
+#define __com_sun_star_document_XBinaryStreamResolver_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/io/XInputStream.idl>
+#include <com/sun/star/io/XOutputStream.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/**
+ <p>This interface encapsulates functionality to get/resolve binary data streams.
+ It is used to transform binary data to a URL or to transform a URL to binary
+ data. The binary data is represented through input and output streams.</p>
+
+ <p>In the case of transforming a URL to binary data, the <code>getInputStream</code>
+ method is used. This returns a com::sun::star::io::XInputStream
+ from which the binary data, transformed from the given URL, can be read.</p>
+
+ <p>In the case of transforming binary data to a URL, a
+ com::sun::star::io::XOutputStream is created first to write
+ the binary data to. After this, the <code>resolveOutputStream</code> method can
+ be used to transform the binary data, represented through the
+ com::sun::star::io::XOutputStream interface, to a URL.</p>
+ */
+published interface XBinaryStreamResolver: com::sun::star::uno::XInterface
+{
+ /** converts the given URL from the source URL namespace to an input stream,
+ from which binary data can be read
+ */
+ com::sun::star::io::XInputStream getInputStream( [in] string aURL );
+
+ /** creates an output stream, to which binary data can be written.
+ After writing, a URL can be retrieved by a call to
+ XBinaryStreamResolver::resolveOutputStream().
+ */
+ com::sun::star::io::XOutputStream createOutputStream();
+
+ /** converts the output stream, data has been written to, to a URL in
+ source URL namespace.
+ */
+ string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XCmisDocument.idl b/offapi/com/sun/star/document/XCmisDocument.idl
new file mode 100644
index 000000000..0f6ef8f6e
--- /dev/null
+++ b/offapi/com/sun/star/document/XCmisDocument.idl
@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+#ifndef __com_sun_star_document_XCmisDocument_idl__
+#define __com_sun_star_document_XCmisDocument_idl__
+
+#include <com/sun/star/document/CmisProperty.idl>
+#include <com/sun/star/document/CmisVersion.idl>
+#include <com/sun/star/uno/XInterface.idl>
+
+module com { module sun { module star { module document {
+
+/** The document can provide access to CMIS properties and versions
+ through this interface.
+ */
+interface XCmisDocument : com::sun::star::uno::XInterface
+{
+ /** Check out the document into a private working copy on the
+ server, and update the loaded document to reflect this change.
+ */
+ void checkOut( );
+
+ /** Cancel checked out document, this will discard all changes since
+ check-out.
+ */
+ void cancelCheckOut( );
+
+ /** Creates a new version of the document from the private working
+ copy.
+ */
+ void checkIn( [in] boolean isMajor, [in] string comment );
+
+ /** Tells whether a document can support versioning or not.
+ */
+ boolean isVersionable( );
+
+ boolean canCheckOut( );
+
+ boolean canCancelCheckOut( );
+
+ boolean canCheckIn( );
+
+ void updateCmisProperties( [in] sequence <com::sun::star::document::CmisProperty> cmisProperties );
+
+ sequence <com::sun::star::document::CmisVersion> getAllVersions( );
+
+ /** Contains the properties values named after their CMIS ID.
+ */
+ [attribute] sequence <com::sun::star::document::CmisProperty> CmisProperties;
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XCodeNameQuery.idl b/offapi/com/sun/star/document/XCodeNameQuery.idl
new file mode 100644
index 000000000..2a942eedc
--- /dev/null
+++ b/offapi/com/sun/star/document/XCodeNameQuery.idl
@@ -0,0 +1,38 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XCodeNameQuery_idl__
+#define __com_sun_star_document_XCodeNameQuery_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module document {
+interface XCodeNameQuery
+{
+ string getCodeNameForObject( [in] com::sun::star::uno::XInterface aObj );
+
+ string getCodeNameForContainer( [in] com::sun::star::uno::XInterface aObj );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XCompatWriterDocProperties.idl b/offapi/com/sun/star/document/XCompatWriterDocProperties.idl
new file mode 100644
index 000000000..84c2c986f
--- /dev/null
+++ b/offapi/com/sun/star/document/XCompatWriterDocProperties.idl
@@ -0,0 +1,37 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XCompatWriterDocProperties_idl__
+#define __com_sun_star_document_XCompatWriterDocProperties_idl__
+
+#include <com/sun/star/document/XDocumentProperties.idl>
+
+module com { module sun { module star { module document {
+interface XCompatWriterDocProperties
+{
+// interface ::com::sun::star::document::XDocumentProperties;
+ [attribute] string Manager;
+ [attribute] string Category;
+ [attribute] string Company;
+
+
+}; }; }; };
+};
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl
new file mode 100644
index 000000000..929db7df8
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl
@@ -0,0 +1,105 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XDocumentEventBroadcaster_idl__
+#define __com_sun_star_document_XDocumentEventBroadcaster_idl__
+
+#include <com/sun/star/frame/XController2.idl>
+#include <com/sun/star/document/DocumentEvent.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/lang/NoSupportException.idl>
+
+
+module com { module sun { module star { module document {
+
+interface XDocumentEventListener;
+
+
+/** allows to be notified of events happening in an OfficeDocument, and to cause notification
+ of such events.
+
+ <p>This interface is the successor of the XEventBroadcaster interface, which should not be used
+ anymore.</p>
+
+ @see DocumentEvent
+ @since OOo 3.1
+*/
+interface XDocumentEventBroadcaster
+{
+ /** registers a listener which is notified about document events
+
+ @param Listener
+ the listener to register. The behavior of the method is undefined this listener
+ is `NULL`.
+ */
+ void addDocumentEventListener( [in] XDocumentEventListener Listener );
+
+ /** revokes a listener which has previously been registered to be notified about document events.
+
+ @param Listener
+ the listener to revoke. The behavior of the method is undefined this listener
+ is `NULL`.
+ */
+ void removeDocumentEventListener( [in] XDocumentEventListener Listener );
+
+ /** causes the broadcaster to notify all registered listeners of the given event
+
+ <p>The method will create a DocumentEvent instance with the given parameters,
+ and fill in the <code>Source</code> member (denoting the broadcaster) as appropriate.</p>
+
+ <p>Whether the actual notification happens synchronously or asynchronously is up to the
+ implementor of this method. However, implementations are encouraged to specify this, for the
+ list of supported event types, in their service contract.</p>
+
+ <p>Implementations might also decide to limit the list of allowed events (means event names) at
+ their own discretion. Again, in this case they're encouraged to document this in their service
+ contract.</p>
+
+ @param EventName
+ the name of the event to be notified.
+ @param ViewController
+ the view/controller which the event applies to. May be `NULL`
+ @param Supplement
+ supplemental information related to the event.
+
+ @throws ::com::sun::star::lang::IllegalArgumentException
+ if EventName is empty, or if EventName is not supported by the
+ document implementation.
+
+ @throws ::com::sun::star::lang::NoSupportException
+ if the broadcaster implementation does not supported broadcasting events induced externally.
+ This is usually used for components which multiplex events from multiple sources, and thus would
+ be unable to fill in the <code>Source</code> member of the DocumentEvent instance.
+ */
+ void notifyDocumentEvent(
+ [in] string EventName,
+ [in] ::com::sun::star::frame::XController2 ViewController,
+ [in] any Supplement
+ )
+ raises ( ::com::sun::star::lang::IllegalArgumentException,
+ ::com::sun::star::lang::NoSupportException );
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentEventListener.idl b/offapi/com/sun/star/document/XDocumentEventListener.idl
new file mode 100644
index 000000000..b3c249f60
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentEventListener.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XDocumentEventListener_idl__
+#define __com_sun_star_document_XDocumentEventListener_idl__
+
+#include <com/sun/star/lang/XEventListener.idl>
+#include <com/sun/star/document/DocumentEvent.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** allows to be notified of events happening in an OfficeDocument
+
+ <p>This interface is the successor of the XEventListener interface, which should not be used
+ anymore.</p>
+
+ @see XDocumentEventBroadcaster
+ @since OOo 3.1
+ */
+interface XDocumentEventListener : ::com::sun::star::lang::XEventListener
+{
+ /** is called whenever a document event occurred
+ */
+ void documentEventOccured( [in] DocumentEvent Event );
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentInsertable.idl b/offapi/com/sun/star/document/XDocumentInsertable.idl
new file mode 100644
index 000000000..340305c6d
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentInsertable.idl
@@ -0,0 +1,58 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XDocumentInsertable_idl__
+#define __com_sun_star_document_XDocumentInsertable_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/beans/PropertyValue.idl>
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+#include <com/sun/star/io/IOException.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** Makes it possible to import a document from a given URL
+ into this document.
+ */
+published interface XDocumentInsertable: com::sun::star::uno::XInterface
+{
+ /** Inserts the document that is specified by the URL.
+ The document will be inserted at the current cursor position.
+
+ Make sure that you insert at a position which can be split
+ in two paragraphs (i.e. not inside of a field).
+ */
+ void insertDocumentFromURL( [in] string aURL,
+ [in] sequence<com::sun::star::beans::PropertyValue> aOptions )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::io::IOException );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentLanguages.idl b/offapi/com/sun/star/document/XDocumentLanguages.idl
new file mode 100644
index 000000000..6658f9f23
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentLanguages.idl
@@ -0,0 +1,46 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XDocumentLanguages_idl__
+#define __com_sun_star_document_XDocumentLanguages_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/lang/Locale.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+
+module com { module sun { module star { module document {
+
+interface XDocumentLanguages: com::sun::star::uno::XInterface
+{
+ /** retrieve the list of languages already used in current document
+
+ @returns
+ sequence
+ */
+ sequence< com::sun::star::lang::Locale > getDocumentLanguages( [in] short nScriptTypes, [in] short nCount )
+ raises( com::sun::star::lang::IllegalArgumentException );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentProperties.idl b/offapi/com/sun/star/document/XDocumentProperties.idl
new file mode 100644
index 000000000..5a4b1f5c2
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentProperties.idl
@@ -0,0 +1,398 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XDocumentProperties_idl__
+#define __com_sun_star_document_XDocumentProperties_idl__
+
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/util/DateTime.idl>
+#include <com/sun/star/lang/Locale.idl>
+#include <com/sun/star/beans/NamedValue.idl>
+#include <com/sun/star/embed/XStorage.idl>
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/io/WrongFormatException.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/beans/XPropertyContainer.idl>
+
+
+
+module com { module sun { module star { module document {
+
+/** provides document-specific information such as the author, creation date,
+ and user-defined fields.
+
+ <p>
+ This interface manages access to document meta-data properties.
+ Such properties may be set from the outside via the setter methods
+ (e.g. when importing arbitrary document formats that support
+ document properties), or imported from an ODF package via the methods
+ loadFromStorage() and loadFromMedium().
+ The properties may also be stored via the methods
+ storeToStorage() and storeToMedium().
+ </p>
+
+ @since OOo 3.0
+
+ @see XDocumentPropertiesSupplier
+ for getting access to an instance from a loaded document
+ @see DocumentProperties for a service that implements this interface
+ */
+published interface XDocumentProperties
+{
+ /** contains the initial author of the document.
+ */
+
+ [attribute] string Author;
+
+ /** identifies which application was used to create or last modify the
+ document.
+ <p>
+ The generating application will set this attribute when it creates a
+ new document or it saves a document. When a document is loaded that
+ itself contains such an attribute it will be preserved until the
+ document is saved again.
+ </p>
+ */
+
+ [attribute] string Generator;
+
+ /** contains the date and time when the document was created.
+ */
+
+ [attribute] com::sun::star::util::DateTime CreationDate;
+
+ /** contains the title of the document.
+ */
+
+ [attribute] string Title;
+
+ /** contains the subject of the document.
+ */
+
+ [attribute] string Subject;
+
+ /** contains a multi-line comment describing the document.
+ <p>
+ Line delimiters can be UNIX, Macintosh or DOS style.
+ </p>
+ */
+
+ [attribute] string Description;
+
+ /** contains a list of keywords for the document.
+ */
+
+ [attribute] sequence< string > Keywords;
+
+ /** contains the default language of the document.
+ */
+
+ [attribute] com::sun::star::lang::Locale Language;
+
+ /** contains the name of the person who most recently stored the document.
+ */
+
+ [attribute] string ModifiedBy;
+
+ /** contains the date and time of the last time the document was stored.
+ <p>
+ If the document has never been stored, contains a default value.
+ </p>
+ */
+
+ [attribute] com::sun::star::util::DateTime ModificationDate;
+
+ /** contains the name of the person who most recently printed the document.
+ */
+
+ [attribute] string PrintedBy;
+
+ /** contains the date and time when the document was last printed.
+ <p>
+ If the document has never been printed, contains a default value.
+ </p>
+ */
+
+ [attribute] com::sun::star::util::DateTime PrintDate;
+
+ /** contains the name of the template from which the document was created.
+ <p>
+ The value is an empty `string` if the document was not
+ created from a template or if it was detached from the template.
+ </p>
+ */
+
+ [attribute] string TemplateName;
+
+ /** contains the URL of the template from which the document was created.
+ <p>
+ The value is an empty `string` if the document was not
+ created from a template or if it was detached from the template.
+ </p>
+ */
+
+ [attribute] string TemplateURL;
+
+ /** contains the date and time of when the document
+ was created or updated from the template.
+ */
+
+ [attribute] com::sun::star::util::DateTime TemplateDate;
+
+ /** contains the URL to load automatically at a
+ specified time after the document is loaded into a desktop frame.
+ <p>
+ An empty URL is valid and describes a case where the document shall be
+ reloaded from its original location after some time described by the
+ attribute #AutoloadSecs.
+ An empty `string` together with an
+ #AutoloadSecs value of 0
+ describes a case where no autoload is specified.
+ </p>
+
+ @see AutoloadSecs
+ */
+
+ [attribute] string AutoloadURL;
+
+ /** contains the number of seconds after which a specified
+ URL is to be loaded after the document is loaded into a desktop
+ frame.
+ <p>
+ A value of 0 is valid and describes a redirection.
+ A value of 0 together with an empty `string` as
+ #AutoloadURL
+ describes a case where no autoload is specified.
+ </p>
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if argument is negative
+
+ @see AutoloadURL
+ */
+
+ [attribute] long AutoloadSecs {
+ set raises ( com::sun::star::lang::IllegalArgumentException );
+ };
+
+ /** contains the name of the default frame into which
+ links should be loaded if no target is specified.
+ <p>
+ This applies to the autoload feature too, but to others as well.
+ </p>
+ */
+
+ [attribute] string DefaultTarget;
+
+ /** contains some statistics about the document.
+ <p>
+ The contained statistics may be specific to the type of the document.
+ </p>
+ */
+
+ [attribute]
+ sequence< com::sun::star::beans::NamedValue > DocumentStatistics;
+
+ /** describes how often the document was edited and saved.
+ <p>
+ </p>
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if argument is negative
+ */
+
+ [attribute] short EditingCycles {
+ set raises ( com::sun::star::lang::IllegalArgumentException );
+ };
+
+ /** contains the net time of editing the document (in seconds).
+ <p>
+ </p>
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if argument is negative
+ */
+
+ [attribute] long EditingDuration {
+ set raises ( com::sun::star::lang::IllegalArgumentException );
+ };
+
+ /** resets all attributes that could identify the user.
+ <p>
+ Clears the document properties, such that it appears the document
+ has just been created.
+ This is a convenience method which resets several attributes at once,
+ as follows:
+ <ul>
+ <li>#Author is set to the given parameter.</li>
+ <li>#CreationDate is set to the current date and time.
+ </li>
+ <li>#ModifiedBy is cleared.</li>
+ <li>#ModificationDate is cleared.</li>
+ <li>#PrintedBy is cleared.</li>
+ <li>#PrintDate is cleared.</li>
+ <li>#EditingDuration is cleared.</li>
+ <li>#EditingCycles is set to 1.</li>
+ </ul>
+
+ @param Author
+ the new value of the #Author attribute.
+ </p>
+ */
+ void resetUserData( [in] string Author );
+
+ /** provides access to a container for user-defined properties.
+ <p>
+ The returned object also implements the interface
+ com::sun::star::beans::XPropertySet.
+ </p>
+ @returns a container that provides access to user-defined properties
+ */
+
+ com::sun::star::beans::XPropertyContainer getUserDefinedProperties();
+
+ /** loads document properties from an ODF package.
+ <p>
+ This method is used for accessing an ODF package that is owned by
+ someone else, e.g., a document.
+ </p>
+
+ @param Storage
+ the com::sun::star::embed::Storage representing the
+ ODF package
+
+ @param Medium
+ the com::sun::star::document::MediaDescriptor
+ representing the source
+ <p>
+ This is unfortunately necessary in order to properly resolve
+ relative URLs in the meta-data.
+ </p>
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if argument is `NULL`
+ @throws com::sun::star::io::WrongFormatException
+ if parsing the XML document fails
+ @throws com::sun::star::lang::WrappedTargetException
+ if thrown when trying to open a stream in the given storage
+ @throws com::sun::star::io::IOException
+ if thrown when trying to open a stream in the given storage
+ */
+
+ void loadFromStorage( [in] com::sun::star::embed::XStorage Storage,
+ [in] sequence < com::sun::star::beans::PropertyValue > Medium )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::io::WrongFormatException,
+ com::sun::star::lang::WrappedTargetException,
+ com::sun::star::io::IOException );
+
+ /** loads document properties from an ODF package or an OLE container.
+
+ @param URL
+ the URL of the source document
+ <p>
+ The URL could be part of the Medium parameter, but because often
+ no other parameters except the URL are needed, providing it
+ separately was added for convenience.
+ </p>
+
+ @param Medium
+ the com::sun::star::document::MediaDescriptor
+ representing the source
+
+ @throws com::sun::star::io::WrongFormatException
+ if parsing the XML document fails
+ @throws com::sun::star::lang::WrappedTargetException
+ if thrown when trying to open a stream in the given storage
+ @throws com::sun::star::io::IOException
+ if thrown when trying to open a stream in the given storage
+ */
+
+ void loadFromMedium( [in] string URL,
+ [in] sequence < com::sun::star::beans::PropertyValue > Medium )
+ raises( com::sun::star::io::WrongFormatException,
+ com::sun::star::lang::WrappedTargetException,
+ com::sun::star::io::IOException );
+
+ /** stores document properties to an ODF package.
+ <p>
+ This method is used for accessing an ODF package that is owned by
+ someone else, e.g., a document.
+ Note that the implementation may choose to store the meta-data
+ in either OOo or ODF format, depending on the MediaType property
+ of the given Storage argument.
+ </p>
+
+ @param Storage
+ the com::sun::star::embed::Storage representing the
+ ODF package
+
+ @param Medium
+ the com::sun::star::document::MediaDescriptor
+ representing the source
+ <p>
+ This is unfortunately necessary in order to properly resolve
+ relative URLs in the meta-data.
+ </p>
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if argument is `NULL`
+ @throws com::sun::star::lang::WrappedTargetException
+ if thrown when trying to open a stream in the given storage
+ @throws com::sun::star::io::IOException
+ if thrown when writing to the storage
+ */
+
+ void storeToStorage( [in] com::sun::star::embed::XStorage Storage,
+ [in] sequence < com::sun::star::beans::PropertyValue > Medium )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::lang::WrappedTargetException,
+ com::sun::star::io::IOException );
+
+ /** stores document properties to an ODF package or an OLE container.
+
+ @param URL
+ the URL of the target document
+ <p>
+ The URL could be part of the Medium parameter, but because often
+ no other parameters except the URL are needed, providing it
+ separately was added for convenience.
+ </p>
+
+ @param Medium
+ the com::sun::star::document::MediaDescriptor
+ representing the target
+
+ @throws com::sun::star::lang::WrappedTargetException
+ if thrown when trying to open a stream in the given storage
+ @throws com::sun::star::io::IOException
+ if thrown when writing to the storage
+ */
+
+ void storeToMedium( [in] string URL,
+ [in] sequence < com::sun::star::beans::PropertyValue > Medium )
+ raises( com::sun::star::lang::WrappedTargetException,
+ com::sun::star::io::IOException );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl b/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl
new file mode 100644
index 000000000..29c29d9cd
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl
@@ -0,0 +1,55 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XDocumentPropertiesSupplier_idl__
+#define __com_sun_star_document_XDocumentPropertiesSupplier_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/document/XDocumentProperties.idl>
+
+
+module com { module sun { module star { module document {
+
+/** provides access to the XDocumentProperties instance of a
+ document.
+ <p>
+ A DocumentProperties instance is available on loaded documents
+ via this supplier interface.
+ </p>
+
+ @since OOo 3.0
+
+ @see XDocumentProperties
+ @see DocumentProperties
+ */
+published interface XDocumentPropertiesSupplier
+{
+ /** provides the document properties object.
+
+ @returns
+ an object of type XDocumentProperties
+ */
+ XDocumentProperties getDocumentProperties();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentRecovery.idl b/offapi/com/sun/star/document/XDocumentRecovery.idl
new file mode 100644
index 000000000..914a091b6
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentRecovery.idl
@@ -0,0 +1,119 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XDocumentRecovery_idl__
+#define __com_sun_star_document_XDocumentRecovery_idl__
+
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/lang/WrappedTargetException.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** is the interface to be implemented by documents who wish to participate in
+ the document emergency-save / recovery process.
+ */
+interface XDocumentRecovery
+{
+ /** determines whether the document has been modified since the last call to storeToRecoveryFile().
+
+ <p>If <code>storeToRecoveryFile</code> has not been called before, this method returns whether the document
+ has been modified since it has been loaded respectively created.</p>
+
+ <p>When saving a session, either in case of an emergency (when OpenOffice.org crashed), or during a
+ periodic session save as configured by the user, storeToRecoveryFile() is called for every
+ document where <code>wasModifiedSinceLastSave</code> returns `TRUE`.</p>
+
+ <p>It's allowed to implement this method sloppy, by returning `TRUE` in cases where it is not sure whether
+ the document actually has been modified. So, the most simple implementation could simply delegate this call
+ to com::sun::star::util::XModifiable::isModified(). (Well, actually that's the
+ second simple implementation, the <em>most</em> simple one would, still legitimately, always return `TRUE`.)</p>
+
+ <p>However, in such a case, the document might be saved more often than needed. In particular during the
+ periodic session save, this might become a problem when saving is expensive, for a single document
+ or the sum of all open documents.</p>
+ */
+ boolean wasModifiedSinceLastSave();
+
+ /** does an emergency save of the document
+
+ <p>A default implementation of this method could simply delegate this call to
+ com::sun::star::frame::XStorable::storeToURL().</p>
+
+ @param TargetLocation
+ specifies the URL of the location to which the document should be emergency-saved.
+
+ @param MediaDescriptor
+ contains additional arguments for the save process, for instance a StatusIndicator.
+
+ @see MediaDescriptor
+ */
+ void storeToRecoveryFile(
+ [in] string TargetLocation,
+ [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor
+ )
+ raises ( ::com::sun::star::io::IOException,
+ ::com::sun::star::lang::WrappedTargetException
+ );
+
+ /** recovers the document after a previous emergency or session save.
+
+ <p>The document itself has previously been created, but <em>not</em> loaded
+ (via com::sun::star::frame::XLoadable::load()) or initialized (via
+ com::sun::star::frame::XLoadable::initNew()).</p>
+
+ <p>Upon successful return, the document must be fully initialized. In particular, the
+ caller is not responsible for calling com::sun::star::frame::XModel::attachResource().
+ Instead, the implementation is responsible to do so, if required.</p>
+
+ <p>A default implementation of this method could simply delegate this call to
+ ::com::sun::star::frame::XLoadable::load(), followed by
+ com::sun::star::frame::XModel::attachResource().</p>
+
+ @param SourceLocation
+ specifies the URL of the location to which the document was previously emergency-saved.
+
+ @param SalvagedFile
+ specifies the original URL of the file which had been emergency-saved. If this is empty,
+ then the file should be recovered from its original location.
+
+ @param MediaDescriptor
+ contains additional arguments for the load process, for instance a StatusIndicator.
+
+ @see MediaDescriptor
+ */
+ void recoverFromFile(
+ [in] string SourceLocation,
+ [in] string SalvagedFile,
+ [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor
+ )
+ raises ( ::com::sun::star::io::IOException,
+ ::com::sun::star::lang::WrappedTargetException
+ );
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentRevisionListPersistence.idl b/offapi/com/sun/star/document/XDocumentRevisionListPersistence.idl
new file mode 100644
index 000000000..f8aa9f5ce
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentRevisionListPersistence.idl
@@ -0,0 +1,62 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XDocumentRevisionListPersistence_idl__
+#define __com_sun_star_document_XDocumentRevisionListPersistence_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/embed/XStorage.idl>
+#include <com/sun/star/util/RevisionTag.idl>
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/container/NoSuchElementException.idl>
+#include <com/sun/star/uno/Exception.idl>
+
+
+module com { module sun { module star { module document {
+
+/** interface to load or store a list of document revisions from or to a document
+ using the packed XML file format
+ */
+interface XDocumentRevisionListPersistence: com::sun::star::uno::XInterface
+{
+ /** Loads a list of available revisions from a storage
+ <p>
+ This method does not load any revision itself
+ </p>
+ */
+ sequence < ::com::sun::star::util::RevisionTag > load( [in] ::com::sun::star::embed::XStorage Storage)
+ raises( com::sun::star::container::NoSuchElementException,
+ com::sun::star::io::IOException,
+ com::sun::star::uno::Exception );
+
+ /** Stores a list of available revisions to a storage
+ <p>
+ This method does not store revisions themselves
+ </p>
+ */
+ void store( [in] ::com::sun::star::embed::XStorage Storage, [in] sequence < ::com::sun::star::util::RevisionTag > List )
+ raises( com::sun::star::io::IOException,
+ com::sun::star::uno::Exception );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl b/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl
new file mode 100644
index 000000000..044bd98f3
--- /dev/null
+++ b/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl
@@ -0,0 +1,67 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XDocumentSubStorageSupplier_idl__
+#define __com_sun_star_document_XDocumentSubStorageSupplier_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/embed/XStorage.idl>
+
+
+
+module com { module sun { module star { module document {
+
+/** through this interface documents can provide access to their substorages
+
+ <p>
+ A temporary interface to get access to documents substorages.
+ </p>
+ */
+interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface
+{
+ /** provides the access to a substorage with specified name
+
+ @param StorageName
+ the name of requested substorage
+
+ @param nMode
+ a mode the storage should be opened in can take value from ::com::sun::star::embed::ElementModes
+
+ @returns
+ XStorage implementation that refers to specified substorage
+ */
+ com::sun::star::embed::XStorage getDocumentSubStorage(
+ [in] string StorageName,
+ [in] long nMode );
+
+ /** provides the list of substorages
+
+ @returns
+ sequence of substorages names
+ */
+ sequence< string > getDocumentSubStoragesNames()
+ raises( ::com::sun::star::io::IOException );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl b/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl
new file mode 100644
index 000000000..bbba8de4d
--- /dev/null
+++ b/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl
@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XEmbeddedObjectResolver_idl__
+#define __com_sun_star_document_XEmbeddedObjectResolver_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** this interface converts embedded object URLs from one URL space to another.
+ */
+published interface XEmbeddedObjectResolver: com::sun::star::uno::XInterface
+{
+ /** converts the given URL from the source URL namespace to the destination
+ URL space of this instance.
+ */
+ string resolveEmbeddedObjectURL( [in] string aURL );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl b/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl
new file mode 100644
index 000000000..dfe393e70
--- /dev/null
+++ b/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl
@@ -0,0 +1,46 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XEmbeddedObjectSupplier_idl__
+#define __com_sun_star_document_XEmbeddedObjectSupplier_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/lang/XComponent.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** represents something that provides an embedded object.
+ */
+published interface XEmbeddedObjectSupplier: com::sun::star::uno::XInterface
+{
+ /** returns the object which is embedded into this object.
+ */
+ com::sun::star::lang::XComponent getEmbeddedObject();
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XEmbeddedObjectSupplier2.idl b/offapi/com/sun/star/document/XEmbeddedObjectSupplier2.idl
new file mode 100644
index 000000000..22b957366
--- /dev/null
+++ b/offapi/com/sun/star/document/XEmbeddedObjectSupplier2.idl
@@ -0,0 +1,60 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XEmbeddedObjectSupplier2_idl__
+#define __com_sun_star_document_XEmbeddedObjectSupplier2_idl__
+
+#include <com/sun/star/embed/XEmbeddedObject.idl>
+
+#include <com/sun/star/graphic/XGraphic.idl>
+#include <com/sun/star/document/XEmbeddedObjectSupplier.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** represents something that provides an embedded object.
+ */
+interface XEmbeddedObjectSupplier2: com::sun::star::document::XEmbeddedObjectSupplier
+{
+ /** returns the object which is embedded into this object.
+
+ <p>
+ This method does not return the model that is controlled by the
+ embedded object, but the embedded object itself.
+ </p>
+ */
+ com::sun::star::embed::XEmbeddedObject getExtendedControlOverEmbeddedObject();
+
+ /** allows to control the aspect of the object.
+ */
+ [attribute] hyper Aspect;
+
+ /** allows to get the replacement image of the object.
+ */
+ [attribute,readonly] com::sun::star::graphic::XGraphic ReplacementGraphic;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XEmbeddedScripts.idl b/offapi/com/sun/star/document/XEmbeddedScripts.idl
new file mode 100644
index 000000000..c7ef5ea4e
--- /dev/null
+++ b/offapi/com/sun/star/document/XEmbeddedScripts.idl
@@ -0,0 +1,60 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XEmbeddedScripts_idl__
+#define __com_sun_star_document_XEmbeddedScripts_idl__
+
+#include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** is supported by OfficeDocuments which allow to embed scripts
+
+ @since OOo 2.4
+ */
+interface XEmbeddedScripts
+{
+ /** is the container of <code>StarBasic</code> macro libraries contained in the document
+ */
+ [attribute, readonly] ::com::sun::star::script::XStorageBasedLibraryContainer BasicLibraries;
+
+ /** is the container of dialogs libraries contained in the document
+ */
+ [attribute, readonly] ::com::sun::star::script::XStorageBasedLibraryContainer DialogLibraries;
+
+ /** determines whether executing macros from this document is allowed.
+
+ <p>Effectively, this attribute is an evaluation of the document's MacroExecMode
+ against possibly applicable configuration settings, the document location in relation to the
+ trusted location, and the like.</p>
+
+ @see MacroExecMode
+ */
+ [attribute, readonly] boolean AllowMacroExecution;
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XEventBroadcaster.idl b/offapi/com/sun/star/document/XEventBroadcaster.idl
new file mode 100644
index 000000000..140b0b6ab
--- /dev/null
+++ b/offapi/com/sun/star/document/XEventBroadcaster.idl
@@ -0,0 +1,56 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XEventBroadcaster_idl__
+#define __com_sun_star_document_XEventBroadcaster_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/document/XEventListener.idl>
+
+
+module com { module sun { module star { module document {
+
+/** makes it possible to register listeners which are called whenever
+ a document event (see EventObject) occurs
+
+ @deprecated
+ @see XDocumentEventBroadcaster
+ */
+published interface XEventBroadcaster: com::sun::star::uno::XInterface
+{
+ /** registers the given listener
+
+ @param Listener
+ listener which is interested on such events
+ */
+ void addEventListener( [in] XEventListener Listener );
+
+ /** unregisters the given listener
+
+ @param Listener
+ listener which isn't interested on such events any longer
+ */
+ void removeEventListener( [in] XEventListener Listener );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XEventListener.idl b/offapi/com/sun/star/document/XEventListener.idl
new file mode 100644
index 000000000..213583c11
--- /dev/null
+++ b/offapi/com/sun/star/document/XEventListener.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XEventListener_idl__
+#define __com_sun_star_document_XEventListener_idl__
+
+#include <com/sun/star/lang/XEventListener.idl>
+#include <com/sun/star/document/EventObject.idl>
+
+
+module com { module sun { module star { module document {
+
+/** makes it possible to register listeners, which are called whenever
+ a document or document content event occurs
+
+ <p>Such events will be broadcasted by a XEventBroadcaster.</p>
+
+ @deprecated
+ @see XDocumentEventListener
+ */
+published interface XEventListener: com::sun::star::lang::XEventListener
+{
+ /** is called whenever a document event (see EventObject) occurs
+
+ @param Event
+ specifies the event type
+ */
+ void notifyEvent( [in] EventObject Event );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XEventsSupplier.idl b/offapi/com/sun/star/document/XEventsSupplier.idl
new file mode 100644
index 000000000..46d303558
--- /dev/null
+++ b/offapi/com/sun/star/document/XEventsSupplier.idl
@@ -0,0 +1,45 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XEventsSupplier_idl__
+#define __com_sun_star_document_XEventsSupplier_idl__
+
+#include <com/sun/star/container/XNameReplace.idl>
+
+
+module com { module sun { module star { module document {
+
+/** gives access to a list of URLs bound to events of this object
+ */
+published interface XEventsSupplier: com::sun::star::uno::XInterface
+{
+ /** offers a list of event handlers which are be bound to events of
+ this object
+
+ @returns
+ an Events description object
+ */
+ com::sun::star::container::XNameReplace getEvents();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XExporter.idl b/offapi/com/sun/star/document/XExporter.idl
new file mode 100644
index 000000000..ca175d787
--- /dev/null
+++ b/offapi/com/sun/star/document/XExporter.idl
@@ -0,0 +1,62 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XExporter_idl__
+#define __com_sun_star_document_XExporter_idl__
+
+#include <com/sun/star/lang/XComponent.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+
+module com { module sun { module star { module document {
+
+/** makes it possible to connect a document with an ExportFilter
+
+ <p>
+ An ExportFilter must know the source of his filter operation.
+ To set this on a filter is part of this interface.
+ Same mechanism exist for import too.
+ </p>
+
+ @see ExportFilter
+ @see ImportFilter
+ @see XImporter
+ */
+published interface XExporter: com::sun::star::uno::XInterface
+{
+ /** sets the source document for the exporter
+
+ @param Document
+ the source document
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if <var>Document</var> does not support any service which is
+ supported by this exporter
+ */
+ void setSourceDocument(
+ [in] com::sun::star::lang::XComponent Document )
+ raises( com::sun::star::lang::IllegalArgumentException );
+};
+
+
+}; }; }; };
+
+#endif
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XExtendedFilterDetection.idl b/offapi/com/sun/star/document/XExtendedFilterDetection.idl
new file mode 100644
index 000000000..879c83937
--- /dev/null
+++ b/offapi/com/sun/star/document/XExtendedFilterDetection.idl
@@ -0,0 +1,68 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XExtendedFilterDetection_idl__
+#define __com_sun_star_document_XExtendedFilterDetection_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+
+
+module com { module sun { module star { module document {
+
+/** provides a "deep" filter detection
+
+ <p>
+ A "deep" filter detection means looking into the document stream to detect
+ the format of it. Services of type ExtendedTypeDetection must support this
+ interface to be called from generic load mechanism of the office for that.
+ </p>
+
+ @see DetectService
+ @see TypeDetection
+ @see FilterFactory
+ */
+published interface XExtendedFilterDetection: com::sun::star::uno::XInterface
+{
+ /** controls agreement of a "flat" TypeDetection
+ with given URL or arguments
+
+ <p>
+ Registered services in configuration, which support this interface for different mime types,
+ will be called automatically to look into the document stream and decide which format it represent.
+ Add the collected information about detected documents in given MediaDescriptor
+ <var>Descriptor</var>. The decision must be returned as any valid type name (which specifies
+ the detected format) or an empty value for unknown formats.
+ </p>
+
+ @param Descriptor
+ represent a MediaDescriptor which can be used to get/set information
+ about the detected document
+
+ @returns
+ an internal type name if format was detected successfully
+ <br>
+ or an empty value for an unknown document format.
+ */
+ string detect( [inout] sequence< com::sun::star::beans::PropertyValue > Descriptor );
+
+}; }; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XFilter.idl b/offapi/com/sun/star/document/XFilter.idl
new file mode 100644
index 000000000..9a17b2bf5
--- /dev/null
+++ b/offapi/com/sun/star/document/XFilter.idl
@@ -0,0 +1,72 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XFilter_idl__
+#define __com_sun_star_document_XFilter_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+
+
+module com { module sun { module star { module document {
+
+/** interface to filter documents
+
+ <p>
+ This interface will be used by service ImportFilter or
+ ExportFilter to support loading/saving of documents in
+ different formats. The target/source of such filter operations must
+ be known <em>before</em> filtering will be started.
+ (see XImporter and XExporter too)
+ Otherwise this interface can't work right.
+ <p>
+
+ @see ImportFilter
+ @see ExportFilter
+ @see XImporter
+ @see XExporter
+ */
+published interface XFilter: com::sun::star::uno::XInterface
+{
+ /** filter the document.
+
+ <p>
+ The given MediaDescriptor holds all necessary information
+ about the document.
+
+ Don't hold hard references to the descriptor items. You must copy needed information!
+ Otherwise we couldn't destroy (for example) an existing input stream!
+ </p>
+ @param aDescriptor
+ the MediaDescriptor describing the respective document.
+ @return a boolean value indicating whether the filter operation was successful or not.
+ */
+ boolean filter( [in] sequence< com::sun::star::beans::PropertyValue > aDescriptor );
+
+ /** cancel the process.
+ */
+ void cancel();
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XFilterAdapter.idl b/offapi/com/sun/star/document/XFilterAdapter.idl
new file mode 100644
index 000000000..226782009
--- /dev/null
+++ b/offapi/com/sun/star/document/XFilterAdapter.idl
@@ -0,0 +1,56 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef _COM_SUN_STAR_DOCUMENT_XFILTERADAPTER_IDL__
+#define _COM_SUN_STAR_DOCUMENT_XFILTERADAPTER_IDL__
+
+#include <com/sun/star/uno/RuntimeException.idl>
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/io/XInputStream.idl>
+#include <com/sun/star/io/XOutputStream.idl>
+
+
+module com { module sun { module star { module document {
+
+
+ /** This is an interface that can be used to link a filter to the
+ FilterAdapter
+
+ @throws com::sun::star::uno::RuntimeException
+
+ @since OOo 1.1.2
+ */
+published interface XFilterAdapter : com::sun::star::uno::XInterface
+ {
+ void convert(
+ [in] com::sun::star::io::XInputStream xml,
+ [in] com::sun::star::io::XOutputStream device,
+ [in] boolean convertToOffice,
+ [in] string pluginUrl,
+ [in] string fileName);
+ /*raises( com::sun::star::uno::RuntimeException );*/
+
+ };
+ };
+ };
+ };
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XGraphicObjectResolver.idl b/offapi/com/sun/star/document/XGraphicObjectResolver.idl
new file mode 100644
index 000000000..2296a0c2c
--- /dev/null
+++ b/offapi/com/sun/star/document/XGraphicObjectResolver.idl
@@ -0,0 +1,49 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XGraphicObjectResolver_idl__
+#define __com_sun_star_document_XGraphicObjectResolver_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** this interface converts graphic object URLs from one URL space to another.
+
+ @deprecated since LibreOffice 6.1
+ Use GraphicStorageHandler or GraphicProvider to load an XGraphic instead
+ as converting to internal GraphicObject URL is not possible anymore.
+ */
+published interface XGraphicObjectResolver: com::sun::star::uno::XInterface
+{
+ /** converts the given URL from the source URL namespace to the destination
+ URL space of this instance.
+
+ @deprecated since LibreOffice 6.1 - throws a RuntimeException if called
+ */
+ string resolveGraphicObjectURL( [in] string aURL );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XGraphicStorageHandler.idl b/offapi/com/sun/star/document/XGraphicStorageHandler.idl
new file mode 100644
index 000000000..9c70132e0
--- /dev/null
+++ b/offapi/com/sun/star/document/XGraphicStorageHandler.idl
@@ -0,0 +1,53 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ */
+#ifndef __com_sun_star_document_XGraphicStorageHandler_idl__
+#define __com_sun_star_document_XGraphicStorageHandler_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/graphic/XGraphic.idl>
+
+module com { module sun { module star { module document {
+
+/** interface for loading, saving and serializing of XGraphic objects to
+ a document storage
+
+ @since LibreOffice 6.1
+ */
+interface XGraphicStorageHandler : com::sun::star::uno::XInterface
+{
+ /** load a graphic defined by the URL from the storage
+ */
+ com::sun::star::graphic::XGraphic loadGraphic([in] string aURL);
+
+ /** load a graphic from the output stream
+ */
+ com::sun::star::graphic::XGraphic loadGraphicFromOutputStream([in] com::sun::star::io::XOutputStream xOutputStream);
+
+ /** save the graphic to the storage and return the URL reference to
+ its location inside the storage
+ */
+ string saveGraphic([in] com::sun::star::graphic::XGraphic xGraphic);
+
+ /** save the graphic to the storage with a requested name and return
+ the URL reference to its location inside the storage and the mime
+ type of the format that the graphic was saved to as an output parameter
+ */
+ string saveGraphicByName([in] com::sun::star::graphic::XGraphic xGraphic, [out] string savedMimeType, [in] string aRequestedName);
+
+ /** create an input stream from the input graphic
+ */
+ com::sun::star::io::XInputStream createInputStream([in] com::sun::star::graphic::XGraphic xGraphic);
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XImporter.idl b/offapi/com/sun/star/document/XImporter.idl
new file mode 100644
index 000000000..3325bb789
--- /dev/null
+++ b/offapi/com/sun/star/document/XImporter.idl
@@ -0,0 +1,62 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XImporter_idl__
+#define __com_sun_star_document_XImporter_idl__
+
+#include <com/sun/star/lang/XComponent.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+
+module com { module sun { module star { module document {
+
+/** makes it possible to connect a document with an ImportFilter
+
+ <p>
+ An ImportFilter must know the target of his filter operation.
+ To set this on a filter is part of this interface.
+ Same mechanism exist for export too.
+ </p>
+
+ @see ExportFilter
+ @see ImportFilter
+ @see XExporter
+ */
+published interface XImporter: com::sun::star::uno::XInterface
+{
+ /** sets the target document for the importer
+
+ @param Document
+ the target document
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if <var>Document</var> does not support any service which is
+ supported by this importer
+ */
+ void setTargetDocument(
+ [in] com::sun::star::lang::XComponent Document )
+ raises( com::sun::star::lang::IllegalArgumentException );
+};
+
+
+}; }; }; };
+
+#endif
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XInteractionFilterOptions.idl b/offapi/com/sun/star/document/XInteractionFilterOptions.idl
new file mode 100644
index 000000000..27a0704bc
--- /dev/null
+++ b/offapi/com/sun/star/document/XInteractionFilterOptions.idl
@@ -0,0 +1,53 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XInteractionFilterOptions_idl__
+#define __com_sun_star_document_XInteractionFilterOptions_idl__
+
+#include <com/sun/star/task/XInteractionContinuation.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+
+
+module com { module sun { module star { module document {
+
+/** A continuation to return filter options from interaction helper.
+
+ @since OOo 1.1.2
+*/
+published interface XInteractionFilterOptions : ::com::sun::star::task::XInteractionContinuation
+{
+ /** Store results to the continuation.
+
+ @param rProperties the list of properties containing filter options.
+
+ */
+ void setFilterOptions( [in] sequence< com::sun::star::beans::PropertyValue > rProperties );
+
+ /** Get results from the continuation.
+
+ @returns the stored list of properties containing filter options.
+ */
+ sequence< com::sun::star::beans::PropertyValue > getFilterOptions();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XInteractionFilterSelect.idl b/offapi/com/sun/star/document/XInteractionFilterSelect.idl
new file mode 100644
index 000000000..0440fa1a4
--- /dev/null
+++ b/offapi/com/sun/star/document/XInteractionFilterSelect.idl
@@ -0,0 +1,67 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XInteractionFilterSelect_idl__
+#define __com_sun_star_document_XInteractionFilterSelect_idl__
+
+#include <com/sun/star/task/XInteractionContinuation.idl>
+
+
+module com { module sun { module star { module document {
+
+/** continuation used by interaction mechanism at filter detection during
+ loading documents
+
+ <p>
+ If during loading time the filter can't be detected and wasn't given at calling time,
+ a possible com::sun::star::task::InteractionHandler will be used.
+ (it's a part of used MediaDescriptor)
+ A NoSuchFilterRequest will be used then to start right interaction on that to
+ get a decision which filter should be used for given URL. A possible continuation
+ of that can be this XInteractionFilterSelect. It will transport the decision back to
+ generic filter detection and force using of it. Of course it's possible to abort
+ the loading process by use another continuation com::sun::star::task::XInteractionAbort.
+ </p>
+
+ @see MediaDescriptor
+ @see com::sun::star::task::InteractionHandler
+ @see NoSuchFilterRequest
+ @see com::sun::star::task::XInteractionAbort
+ */
+published interface XInteractionFilterSelect : com::sun::star::task::XInteractionContinuation
+{
+ /** used by interaction to set selected filter
+
+ <p>
+ This value must be saved till another one will be set
+ and must be provided on getFilter() for interest users.
+ </p>
+ */
+ void setFilter( [in] string Name );
+
+ /** used by detection to get selected filter
+ */
+ string getFilter();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XLinkTargetSupplier.idl b/offapi/com/sun/star/document/XLinkTargetSupplier.idl
new file mode 100644
index 000000000..31e44ca0f
--- /dev/null
+++ b/offapi/com/sun/star/document/XLinkTargetSupplier.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XLinkTargetSupplier_idl__
+#define __com_sun_star_document_XLinkTargetSupplier_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/container/XNameAccess.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** interface is supplied by objects inside a document object model that have
+ children that can be the target of a link inside a document.
+
+ <p>These targets implement the service LinkTarget. </p>
+ */
+published interface XLinkTargetSupplier: com::sun::star::uno::XInterface
+{
+ /** @returns
+ the names of possible links to children of this object inside a
+ document object model. It implements the service LinkTargets.
+ */
+ com::sun::star::container::XNameAccess getLinks();
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XMLBasicExporter.idl b/offapi/com/sun/star/document/XMLBasicExporter.idl
new file mode 100644
index 000000000..d994a2174
--- /dev/null
+++ b/offapi/com/sun/star/document/XMLBasicExporter.idl
@@ -0,0 +1,49 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XMLBasicExporter_idl__
+#define __com_sun_star_document_XMLBasicExporter_idl__
+
+#include <com/sun/star/xml/sax/XDocumentHandler.idl>
+#include <com/sun/star/document/XXMLBasicExporter.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** Filter for exporting Basic macros to the OpenOffice.org file format.
+
+ <p>First the XExporter::setSourceDocument() method must be
+ called in order to provide the export component with the source document
+ from which the data should be exported. After that, the export is started
+ by calling the XFilter::filter() method.</p>
+
+ @since OOo 2.0
+ */
+published service XMLBasicExporter : XXMLBasicExporter
+{
+ createWithHandler([in] com::sun::star::xml::sax::XDocumentHandler DocumentHandler);
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XMLOasisBasicExporter.idl b/offapi/com/sun/star/document/XMLOasisBasicExporter.idl
new file mode 100644
index 000000000..7befbf100
--- /dev/null
+++ b/offapi/com/sun/star/document/XMLOasisBasicExporter.idl
@@ -0,0 +1,49 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XMLOasisBasicExporter_idl__
+#define __com_sun_star_document_XMLOasisBasicExporter_idl__
+
+#include <com/sun/star/xml/sax/XDocumentHandler.idl>
+#include <com/sun/star/document/XXMLBasicExporter.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** Filter for exporting Basic macros to the OASIS Open Office file format.
+
+ <p>First the XExporter::setSourceDocument() method must be
+ called in order to provide the export component with the source document
+ from which the data should be exported. After that, the export is started
+ by calling the XFilter::filter() method.</p>
+
+ @since OOo 2.0
+ */
+published service XMLOasisBasicExporter : XXMLBasicExporter
+{
+ createWithHandler([in] com::sun::star::xml::sax::XDocumentHandler DocumentHandler);
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XMimeTypeInfo.idl b/offapi/com/sun/star/document/XMimeTypeInfo.idl
new file mode 100644
index 000000000..5733b7d37
--- /dev/null
+++ b/offapi/com/sun/star/document/XMimeTypeInfo.idl
@@ -0,0 +1,50 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XMimeTypeInfo_idl__
+#define __com_sun_star_document_XMimeTypeInfo_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** provides information regarding which MIME types are supported by a filter.
+ */
+published interface XMimeTypeInfo: com::sun::star::uno::XInterface
+{
+
+ /** asks whether a MIME type is supported or not.
+ */
+ boolean supportsMimeType( [in] string MimeTypeName );
+
+
+ /** @returns
+ a sequence of the names of all supported MIME types.
+ */
+ sequence<string> getSupportedMimeTypeNames();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl b/offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl
new file mode 100644
index 000000000..840081663
--- /dev/null
+++ b/offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl
@@ -0,0 +1,105 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XOOXMLDocumentPropertiesImporter_idl__
+#define __com_sun_star_document_XOOXMLDocumentPropertiesImporter_idl__
+
+#include <com/sun/star/document/XDocumentProperties.idl>
+#include <com/sun/star/embed/XStorage.idl>
+#include <com/sun/star/xml/sax/SAXException.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/io/XInputStream.idl>
+
+
+module com { module sun { module star { module document {
+
+/** allows to import the document properties from OOXML format
+ */
+interface XOOXMLDocumentPropertiesImporter: com::sun::star::uno::XInterface
+{
+ /** allows to import the document properties from OOXML format
+
+ <p>
+ The implementation should parse the document properties from OOXML
+ format storage and set them to the target
+ XDocumentProperties implementation.
+ </p>
+
+ <p>
+ The storage must represent OOXML format and support
+ com::sun::star::embed::XRelationshipAccess
+ interface. Please see
+ com::sun::star::embed::StorageFactory for details
+ regarding creation of such a storage.
+ </p>
+
+ @param xSource
+ the source storage representing OOXML document
+
+ @param xDocumentProperties
+ the target XDocumentProperties interface implementation
+
+ @throws ::com::sun::star::lang::IllegalArgumentException
+ the exception is thrown in case unexpected arguments are provided
+
+ @throws ::com::sun::star::xml::sax::SAXException
+ the exception is thrown in case of parsing problems
+
+ @throws ::com::sun::star::uno::Exception
+ the exception is thrown in case of other problems during the import
+ */
+
+ void importProperties(
+ [in] com::sun::star::embed::XStorage xSource,
+ [in] com::sun::star::document::XDocumentProperties xDocumentProperties )
+ raises( com::sun::star::lang::IllegalArgumentException,
+ com::sun::star::xml::sax::SAXException,
+ com::sun::star::uno::Exception );
+
+ /** find and get core properties stream
+
+ (usually it is docProps\core.xml)
+ @since LibreOffice 7.3
+ */
+
+ com::sun::star::io::XInputStream getCorePropertiesStream([in] com::sun::star::embed::XStorage xSource);
+
+ /** find and get extended properties stream
+
+ (usually it is docProps/app.xml)
+ @since LibreOffice 7.3
+ */
+
+ com::sun::star::io::XInputStream getExtendedPropertiesStream([in] com::sun::star::embed::XStorage xSource);
+
+ /** find and get custom properties streams
+
+ (usually it is customXml\*.xml)
+ @since LibreOffice 7.3
+ */
+
+ sequence< com::sun::star::io::XInputStream > getCustomPropertiesStreams([in] com::sun::star::embed::XStorage xSource);
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XRedlinesSupplier.idl b/offapi/com/sun/star/document/XRedlinesSupplier.idl
new file mode 100644
index 000000000..4c7c2b19a
--- /dev/null
+++ b/offapi/com/sun/star/document/XRedlinesSupplier.idl
@@ -0,0 +1,47 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XRedlinesSupplier_idl__
+#define __com_sun_star_document_XRedlinesSupplier_idl__
+
+#include <com/sun/star/container/XEnumerationAccess.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** provides access to a container of the redline objects of the document.
+ */
+published interface XRedlinesSupplier: com::sun::star::uno::XInterface
+{
+ /** @returns
+ an enumeration access that provides access to the redline objects of the document.
+
+ <p>The returned objects implement at least the interface
+ com::sun::star::beans::XPropertySet.
+ Specific objects may support other interfaces as well.</p>
+ */
+ com::sun::star::container::XEnumerationAccess getRedlines();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XScriptInvocationContext.idl b/offapi/com/sun/star/document/XScriptInvocationContext.idl
new file mode 100644
index 000000000..574873188
--- /dev/null
+++ b/offapi/com/sun/star/document/XScriptInvocationContext.idl
@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XScriptInvocationContext_idl__
+#define __com_sun_star_document_XScriptInvocationContext_idl__
+
+
+#include <com/sun/star/document/XEmbeddedScripts.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** indicates support for executing scripts contained in a, possibly foreign, document.
+
+ <p>If the component implementing it is a document, which supports embedding scripts into
+ itself, then #ScriptContainer refers to the document itself. Implementing this
+ interface is unnecessary then, instead the document should simply implement XEmbeddedScripts directly.</p>
+
+ <p>If the interface is implemented by a document which does not itself support embedding
+ scripts into it, but which is associated unambiguously with a document which does,
+ then this other document is denoted by #ScriptContainer.</p>
+
+ <p>If the interface is implemented by a controller, then #ScriptContainer
+ refers to the document which supports embedding scripts, and which is unambiguously
+ associated with the controller. This must not necessarily be the model returned by
+ com::sun::star::frame::XController::getModel().</p>
+
+ @since OOo 2.4
+ */
+interface XScriptInvocationContext
+{
+ /** denotes the document which contains the scripts which are to be invoked from
+ the component implementing the XScriptInvocationContext interface.
+ */
+ [attribute, readonly] XEmbeddedScripts ScriptContainer;
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XShapeEventBroadcaster.idl b/offapi/com/sun/star/document/XShapeEventBroadcaster.idl
new file mode 100644
index 000000000..78a227eb9
--- /dev/null
+++ b/offapi/com/sun/star/document/XShapeEventBroadcaster.idl
@@ -0,0 +1,57 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XShapeEventBroadcaster_idl__
+#define __com_sun_star_document_XShapeEventBroadcaster_idl__
+
+#include <com/sun/star/document/XShapeEventListener.idl>
+#include <com/sun/star/drawing/XShape.idl>
+
+
+module com { module sun { module star { module document {
+
+/**
+ Used to link a listener to a specific shape
+
+ @since LibreOffice 6.4
+ */
+interface XShapeEventBroadcaster : com::sun::star::document::XEventBroadcaster
+{
+ /** registers the given listener
+ @param Shape
+ the shape to be listened
+ @param Listener
+ listener which is interested on such events
+ */
+ void addShapeEventListener( [in] com::sun::star::drawing::XShape Shape, [in] XShapeEventListener Listener );
+
+ /** unregisters the given listener
+ @param Shape
+ the shape with the listener to be removed
+ @param Listener
+ listener which isn't interested on such events any longer
+ */
+ void removeShapeEventListener( [in] com::sun::star::drawing::XShape Shape, [in] XShapeEventListener Listener );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XShapeEventListener.idl b/offapi/com/sun/star/document/XShapeEventListener.idl
new file mode 100644
index 000000000..56634d171
--- /dev/null
+++ b/offapi/com/sun/star/document/XShapeEventListener.idl
@@ -0,0 +1,49 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XShapeEventListener_idl__
+#define __com_sun_star_document_XShapeEventListener_idl__
+
+#include <com/sun/star/document/EventObject.idl>
+
+
+module com { module sun { module star { module document {
+
+/** makes it possible to register listeners, which are called whenever
+ a document or document content event occurs
+
+ <p>Such events will be broadcasted by a XShapeEventBroadcaster.</p>
+
+ @since LibreOffice 6.4
+ */
+interface XShapeEventListener
+{
+ /** is called whenever a document event (see EventObject) occurs
+
+ @param Event
+ specifies the event type
+ */
+ void notifyShapeEvent( [in] EventObject Event );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XStorageBasedDocument.idl b/offapi/com/sun/star/document/XStorageBasedDocument.idl
new file mode 100644
index 000000000..0819fe2cc
--- /dev/null
+++ b/offapi/com/sun/star/document/XStorageBasedDocument.idl
@@ -0,0 +1,87 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XStorageBasedDocument_idl__
+#define __com_sun_star_document_XStorageBasedDocument_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/embed/XStorage.idl>
+#include <com/sun/star/io/IOException.idl>
+#include <com/sun/star/frame/DoubleInitializationException.idl>
+#include <com/sun/star/document/XStorageChangeListener.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+
+
+ module com { module sun { module star { module document {
+
+/** allows to initialize document with a storage, to store document to
+ a storage, and to set document to be based on provided storage.
+ */
+interface XStorageBasedDocument: com::sun::star::uno::XInterface
+{
+ /** lets the document load itself using provided storage.
+ */
+ void loadFromStorage(
+ [in] ::com::sun::star::embed::XStorage xStorage,
+ [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor )
+ raises( ::com::sun::star::lang::IllegalArgumentException,
+ ::com::sun::star::frame::DoubleInitializationException,
+ ::com::sun::star::io::IOException,
+ ::com::sun::star::uno::Exception );
+
+ /** lets the document store itself to the provided storage.
+ */
+ void storeToStorage(
+ [in] ::com::sun::star::embed::XStorage xStorage,
+ [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor )
+ raises( ::com::sun::star::lang::IllegalArgumentException,
+ ::com::sun::star::io::IOException,
+ ::com::sun::star::uno::Exception );
+
+ /** allows to switch the document to the provided storage.
+ */
+ void switchToStorage( [in] ::com::sun::star::embed::XStorage xStorage )
+ raises( ::com::sun::star::lang::IllegalArgumentException,
+ ::com::sun::star::io::IOException,
+ ::com::sun::star::uno::Exception );
+
+
+ /** allows to get the storage the document is based on.
+ */
+ ::com::sun::star::embed::XStorage getDocumentStorage()
+ raises( ::com::sun::star::io::IOException,
+ ::com::sun::star::uno::Exception );
+
+ /** allows to register a listener that will be notified when another
+ storage is set to the document.
+ */
+ void addStorageChangeListener( [in] XStorageChangeListener xListener );
+
+ /** allows to deregister the listener.
+ */
+ void removeStorageChangeListener( [in] XStorageChangeListener xListener );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XStorageChangeListener.idl b/offapi/com/sun/star/document/XStorageChangeListener.idl
new file mode 100644
index 000000000..3e8937952
--- /dev/null
+++ b/offapi/com/sun/star/document/XStorageChangeListener.idl
@@ -0,0 +1,51 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XStorageChangeListener_idl__
+#define __com_sun_star_document_XStorageChangeListener_idl__
+
+#include <com/sun/star/lang/XEventListener.idl>
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/embed/XStorage.idl>
+
+
+module com { module sun { module star { module document {
+
+/** allows to be notified when a document is switched to a new storage.
+ */
+interface XStorageChangeListener: com::sun::star::lang::XEventListener
+{
+ /** is called when document switches to another storage.
+
+ @param xDocument
+ the document that has changed the storage it is based on
+
+ @param xStorage
+ the new storage the document is based on
+ */
+ void notifyStorageChange(
+ [in] ::com::sun::star::uno::XInterface xDocument,
+ [in] ::com::sun::star::embed::XStorage xStorage );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XTypeDetection.idl b/offapi/com/sun/star/document/XTypeDetection.idl
new file mode 100644
index 000000000..5617fac0e
--- /dev/null
+++ b/offapi/com/sun/star/document/XTypeDetection.idl
@@ -0,0 +1,108 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XTypeDetection_idl__
+#define __com_sun_star_document_XTypeDetection_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+
+
+module com { module sun { module star { module document {
+
+/** support "flat" and "deep" type detection of a given document
+
+ <p>
+ A "flat" detection means specifying the document format by using
+ the URL and some configuration data only. That will perform but produce
+ may invalid results if e.g., the extension of the document is wrong.
+ A "deep" detection means looking into the document stream to be right
+ which format it supports. Of course that includes a "flat" detection before.
+ The combination of both ones should produce stable results every time.
+ </p>
+
+ @see TypeDetection
+ */
+published interface XTypeDetection: com::sun::star::uno::XInterface
+{
+ /** make a "flat" detection by using the URL of the document
+
+ <p>
+ It use given URL in combination with the internal configuration of well known
+ types only to specify the format of given document.
+ </p>
+
+ @param URL
+ specify the document by name
+
+ @returns
+ an internal type name which represent the detected format
+ <br>
+ or an empty value for unknown ones
+ */
+ string queryTypeByURL( [in] string URL );
+
+ /** make a "deep" detection or optional a "flat" detection by using a
+ MediaDescriptor
+
+ <p>
+ Instead of XTypeDetection::queryTypeByURL() this function
+ use a MediaDescriptor to specify the document for detection.
+ Such descriptor hold different information about the document.
+ He will be passed to any part of made detection process and every part
+ can change it to actualize it.
+ The property MediaDescriptor::URL should be set on
+ this descriptor as minimum. It specifies the location of the document.
+ If this parameter is missing another one is required: MediaDescriptor::InputStream.
+ This can be useful to prevent operation against multiple opening of the stream
+ and perform the operation. If this stream isn't already included the detection
+ will open it (if allowed!) and add it to the descriptor so it will be available for
+ all following parts.
+ A combination of both parameters can be useful to perform the operation
+ and make results more stable; but only one of them is required.
+ Of course its possible to specify more document properties (e.g.
+ MediaDescriptor::ReadOnly).
+ <br>
+ As an additional feature it's possible to suppress "deep" detection by using argument
+ <var>AllowDeep</var>.
+ </p>
+
+ @param Descriptor
+ means the MediaDescriptor which specify the resource for detection
+
+ @param AllowDeep
+ if it is set to `TRUE` a "deep" detection will be follow a "flat" detection
+ <br>
+ if it is set to `FALSE` a "flat" detection will be made only
+
+ @returns
+ an internal type name which represent the detected format
+ <br>
+ or an empty value for unknown ones
+ */
+ string queryTypeByDescriptor(
+ [inout] sequence< com::sun::star::beans::PropertyValue > Descriptor,
+ [in] boolean AllowDeep );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XUndoAction.idl b/offapi/com/sun/star/document/XUndoAction.idl
new file mode 100644
index 000000000..dd9b13212
--- /dev/null
+++ b/offapi/com/sun/star/document/XUndoAction.idl
@@ -0,0 +1,68 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XUndoAction_idl__
+#define __com_sun_star_document_XUndoAction_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/document/UndoFailedException.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** represents a single (undoable) action on a document
+ @since OOo 3.4
+ */
+interface XUndoAction
+{
+ /** reverts the action represented by the instance
+
+ @throws UndoFailedException
+ if reverting the action failed. In this case, the caller should assume that this is a permanent failure,
+ and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly
+ depending instances.
+ */
+ void undo()
+ raises ( ::com::sun::star::document::UndoFailedException
+ );
+
+ /** repeats the action represented by the instance, after it had previously been reverted.
+
+ @throws UndoFailedException
+ if repeating the action failed. In this case, the caller should assume that this is a permanent failure,
+ and take appropriate action, such as discarding the <code>XUndoAction</code> instance, and any possibly
+ depending instances.
+ */
+ void redo()
+ raises ( ::com::sun::star::document::UndoFailedException
+ );
+
+ /** is the human-readable, localized description of the action.
+ */
+ [attribute, readonly] string Title;
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl
new file mode 100644
index 000000000..9eb3d1d5c
--- /dev/null
+++ b/offapi/com/sun/star/document/XUndoManager.idl
@@ -0,0 +1,330 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XUndoManager_idl__
+#define __com_sun_star_document_XUndoManager_idl__
+
+#include <com/sun/star/document/EmptyUndoStackException.idl>
+#include <com/sun/star/document/UndoContextNotClosedException.idl>
+#include <com/sun/star/document/UndoFailedException.idl>
+#include <com/sun/star/util/InvalidStateException.idl>
+#include <com/sun/star/util/XLockable.idl>
+#include <com/sun/star/container/XChild.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/lang/WrappedTargetException.idl>
+
+
+module com { module sun { module star { module document {
+
+interface XUndoAction;
+interface XUndoManagerListener;
+
+
+/** provides access to the undo/redo stacks of a document
+ <p></p>
+ <h3>Undo</h3>
+ <p>Changes to a document usually result in recording of information how to undo those changes, if desired. A so-called
+ undo action records the information how to undo a single change. Undo actions are maintained in a stack, so that
+ the changes they represent can be undo in the reverse order they have originally been applied.</p>
+
+ <h3>Redo</h3>
+ <p>Additionally, the Undo manager manages a Redo stack: Actions which are undone are moved from the Undo to the Redo
+ stack, so it is possible to re-apply the changes to the document.</p>
+
+ <h3>Undo contexts</h3>
+ <p>For collecting multiple changes in a single undo action, so-called Undo contexts are provided. When an Undo
+ context is entered, all subsequently added Undo actions are not pushed onto the undo stack directly, but considered
+ a sub action of the Undo context. Once the Undo context is left, a single undo action is pushed onto the undo stack,
+ which comprises all those single Undo actions.<br/>
+ Undo contexts can be arbitrarily nested.</p>
+
+ <h3>Hidden Undo actions</h3>
+ <p>Hidden Undo actions are those which in no observable way contribute to the undo stack. That is,
+ any method retrieving information about the stack will behave as if the undo action does not exist. Nonetheless,
+ calling undo() respectively redo() will include those actions.<br/>
+ Hidden Undo actions can be created by calling enterHiddenUndoContext(), following by
+ leaveUndoContext().</p>
+
+ <a name="locking"></a>
+ <h3>Locking</h3>
+ <p>An Undo manager can be locked and unlocked, using the XLockable::lock() and
+ XLockable::unlock() methods. When it is locked, then every attempt to add an undo action, or to
+ enter or leave an Undo context, will be silently ignored.</p>
+
+ @since OOo 3.4
+ */
+interface XUndoManager
+{
+ /** allows <a href="#locking">locking</a> the undo manager.
+ */
+ interface ::com::sun::star::util::XLockable;
+
+ /** allows accessing the component, usually a document, which the undo manager works for.
+
+ <p>com::sun::star::container::XChild::setParent() is not supported, and will throw
+ a com::sun::star::lang::NoSupportException.</p>
+ */
+ interface ::com::sun::star::container::XChild;
+
+ /** enters a new undo context.
+
+ <p>A new undo action will be added to the undo stack, with the title given as <code>iTitle</code>. As long
+ as the context is not left, every undo action added to the stack will be treated as sub action. This means
+ it will not be directly accessible at the Undo manager, not appear in any user interface, and cannot be
+ separately undone or re-done.</p>
+
+ <p>Each call to <code>enterUndoContext</code> must be paired by a call to leaveUndoContext(),
+ otherwise, the document's undo stack is left in an inconsistent state.</p>
+
+ <p>Undo contexts can be nested, i.e. it is legitimate to call <code>enterUndoContext</code> and
+ enterHiddenUndoContext() multiple times without calling leaveUndoContext() inbetween.</p>
+
+ @see leaveUndoContext
+ */
+ void enterUndoContext(
+ [in] string iTitle
+ );
+
+ /** enters a new undo context, creating a hidden undo action.
+
+ <p>A hidden undo action does not, in any visible way, contribute to the undo stack. This means
+ that
+ <ul><li>Calling undo() when the top-element is a hidden undo action will transparently
+ undo this action, and also undo the new top element of the stack.</li>
+ <li>Calling redo() when the top-element is a hidden action will transparently
+ redo this action, and also redo the new top element of the stack.</li>
+ <li>In any user interface presenting the current Undo or Redo actions to the user, a hidden
+ action will not be listed.</p>
+ </ul>
+
+ <p>A new undo action will be added to the undo stack. As long as the context is not left, every undo action
+ added to the stack will be treated as sub action. This means it will not be directly accessible at the undo
+ manager, not appear in any user interface, and cannot be separately undone or re-done.</p>
+
+ <p>Each call to <code>enterHiddenUndoContext</code> must be paired by a call to leaveUndoContext(),
+ otherwise, the document's undo stack is left in an inconsistent state.</p>
+
+ <p>Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext() and
+ <code>enterHiddenUndoContext</code> multiple times without calling leaveUndoContext() inbetween.</p>
+
+ @throws EmptyUndoStackException
+ if the undo stack is currently empty, in which case it is impossible to push a hidden undo action onto
+ it.
+
+ @see enterUndoContext
+ @see leaveUndoContext
+ */
+ void enterHiddenUndoContext()
+ raises( EmptyUndoStackException );
+
+ /** leaves the undo context previously opened via enterUndoContext() respectively
+ enterHiddenUndoContext().
+
+ <p>If no undo action has been added since the context has been opened, the context is not only left,
+ but silently removed, and does not contribute to the undo stack at all. In this case, possible
+ listeners will be notified via XUndoManagerListener::cancelledContext().</p>
+
+ <p>Otherwise, the undo context will be closed, and added to the Undo stack; the redo stack will be cleared,
+ and listeners will be notified via XUndoManagerListener::leftContext() resp.
+ XUndoManagerListener::leftHiddenContext()</p>
+
+ @throws ::com::sun::star::util::InvalidStateException
+ if no undo context is currently open.
+
+ @see enterUndoContext
+ @see enterHiddenUndoContext
+ */
+ void leaveUndoContext()
+ raises( ::com::sun::star::util::InvalidStateException );
+
+ /** adds the given undo action to the undo stack.
+
+ <p>The redo stack is cleared when a new action is pushed onto the undo stack.</p>
+
+ <p>The Undo manager takes ownership of any actions pushed onto the undo stack. This means that if the
+ action is finally removed from the Undo manager's control (e.g. by calling clear() resp.
+ clearRedo()), it will be disposed, as long as it supports the com::sun::star::lang::XComponent
+ interface.</p>
+
+ <p>If the Undo manager is <a href="#locking">locked</a> at the moment the method is called, the call will be ignored, and the undo action
+ will immediately be disposed, if applicable.</p>
+
+ @throws ::com::sun::star::lang::IllegalArgumentException
+ if the given undo action is `NULL`.
+ */
+ void addUndoAction(
+ [in] XUndoAction iAction
+ )
+ raises( ::com::sun::star::lang::IllegalArgumentException );
+
+ /** reverts the most recent action on the document.
+
+ <p>Effectively, invoking this method will
+ <ul><li>invoke XUndoAction::undo() on the top-most action of the undo stack</li>
+ <li>move this undo action from the undo stack to the redo stack</li>
+ </ul></p>
+
+ @throws EmptyUndoStackException
+ if the undo stack is currently empty
+
+ @throws UndoContextNotClosedException
+ if there currently is an open undo context
+
+ @throws UndoFailedException
+ if the invocation of XUndoAction::undo() raised this exception. In this case, the undo stack
+ of the undo manager will have been cleared.
+
+ @see redo
+ @see enterUndoContext
+ */
+ void undo()
+ raises( ::com::sun::star::document::EmptyUndoStackException,
+ ::com::sun::star::document::UndoContextNotClosedException,
+ ::com::sun::star::document::UndoFailedException );
+
+ /** replays the action on the document which has most recently been undone
+
+ <p>Effectively, invoking this method will
+ <ul><li>invoke XUndoAction::redo() on the top-most action of the redo stack</li>
+ <li>move this action from the redo stack to the undo stack</li>
+ </ul></p>
+
+ @throws EmptyUndoStackException
+ when the Redo stack is currently empty
+
+ @throws UndoContextNotClosedException
+ if there currently is an open undo context
+
+ @throws UndoFailedException
+ if the invocation of XUndoAction::redo() raised this exception. In this case, the redo stack
+ of the undo manager will have been cleared.
+
+ @see undo
+ */
+ void redo()
+ raises( ::com::sun::star::document::EmptyUndoStackException,
+ ::com::sun::star::document::UndoContextNotClosedException,
+ ::com::sun::star::document::UndoFailedException );
+
+ /** determines whether undo() can reasonably be expected to succeed.
+
+ @return
+ `FALSE` if and only if the undo stack is currently empty, or there is an open and not-yet-closed
+ undo context.
+ */
+ boolean isUndoPossible();
+
+ /** determines whether redo() can reasonably be expected to succeed.
+
+ @return
+ `FALSE` if and only if the redo stack is currently empty, or there is an open and not-yet-closed
+ undo context.
+ */
+ boolean isRedoPossible();
+
+ /** returns the title of the top-most action on the undo stack
+
+ @throws EmptyUndoStackException
+ when the undo stack is currently empty
+
+ @see XUndoAction::Title
+ */
+ string getCurrentUndoActionTitle()
+ raises( ::com::sun::star::document::EmptyUndoStackException );
+
+ /** returns the title of the top-most action on the Redo stack
+
+ @throws EmptyUndoStackException
+ when the Redo stack is currently empty
+ @see XUndoAction::Title
+ */
+ string getCurrentRedoActionTitle()
+ raises( ::com::sun::star::document::EmptyUndoStackException );
+
+ /** returns the titles of all actions currently on the undo stack, from top to bottom
+ @see XUndoAction::Title
+ */
+ sequence< string >
+ getAllUndoActionTitles();
+
+ /** returns the titles of all actions currently on the Redo stack, from top to bottom
+
+ @see XUndoAction::Title
+ */
+ sequence< string >
+ getAllRedoActionTitles();
+
+ /** clears the undo and the redo stack.
+
+ <p>All actions will be removed from both the Undo and the Redo stack. Actions which implement the
+ com::sun::star::lang::XComponent interface will be disposed.</p>
+
+ @throws UndoContextNotClosedException
+ if the method is invoked while an undo context is still open
+ */
+ void clear()
+ raises( ::com::sun::star::document::UndoContextNotClosedException );
+
+ /** clears the redo stack.
+
+ <p>All actions will be removed from the Redo stack. Actions which implement the com::sun::star::lang::XComponent
+ interface will be disposed.</p>
+
+ @throws UndoContextNotClosedException
+ if the method is invoked while an undo context is still open
+ */
+ void clearRedo()
+ raises( ::com::sun::star::document::UndoContextNotClosedException );
+
+ /** resets the Undo manager
+
+ <p>In particular, this method will
+ <ul><li>remove all locks from the undo manager</li>
+ <li>close all open undo contexts</li>
+ <li>clear the undo stack</li>
+ <li>clear the redo stack</li>
+ </ul></p>
+
+ <p>Note that possible listeners will not get notifications for the single parts of the reset, i.e. there
+ will be no single XUndoManagerListener::allActionsCleared(),
+ XUndoManagerListener::leftContext(), etc., notifications. Instead, listeners will be
+ notified of the reset by calling their XUndoManagerListener::resetAll() method.</p>
+ */
+ void reset();
+
+ /** adds a listener to be notified of changes in the Undo/Redo stacks.
+ */
+ void addUndoManagerListener(
+ [in] XUndoManagerListener iListener
+ );
+
+ /** removes a previously added listener
+ */
+ void removeUndoManagerListener(
+ [in] XUndoManagerListener iListener
+ );
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl
new file mode 100644
index 000000000..449737b72
--- /dev/null
+++ b/offapi/com/sun/star/document/XUndoManagerListener.idl
@@ -0,0 +1,136 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XUndoManagerListener_idl__
+#define __com_sun_star_document_XUndoManagerListener_idl__
+
+#include <com/sun/star/document/UndoManagerEvent.idl>
+#include <com/sun/star/lang/XEventListener.idl>
+
+
+module com { module sun { module star { module document {
+
+
+/** implemented by components which want to be notified of changes in the Undo/Redo stacks of an Undo manager.
+
+ @see XUndoManager
+ @since OOo 3.4
+ */
+interface XUndoManagerListener : ::com::sun::star::lang::XEventListener
+{
+ /** is called when an undo action is added to the undo stack.
+
+ <p>Note that the action must not necessarily be the new top element of the stack: In case there's an
+ open Undo context, UndoManagerEvent::UndoContextDepth will be greater <code>0</code>,
+ and the newly added action will be subordinate of the context action.</p>
+
+ @see XUndoManager::addUndoAction
+ */
+ void undoActionAdded( [in] UndoManagerEvent iEvent );
+
+ /** is called when the top-most action of the undo stack has been undone.
+
+ @see XUndoManager::undo
+ */
+ void actionUndone( [in] UndoManagerEvent iEvent );
+
+ /** is called when the top-most action of the Redo stack has been re-applied.
+
+ @see XUndoManager::redo
+ */
+ void actionRedone( [in] UndoManagerEvent iEvent );
+
+ /** is called when both the Undo and the Redo stack have been cleared from all Undo actions.
+
+ @see XUndoManager::clear
+ */
+ void allActionsCleared( [in] ::com::sun::star::lang::EventObject iEvent );
+
+ /** is called when the Redo stack has been cleared.
+
+ @see XUndoManager::clearRedo
+ */
+ void redoActionsCleared( [in] ::com::sun::star::lang::EventObject iEvent );
+
+ /** called when the complete undo manager has been reset
+ */
+ void resetAll( [in] ::com::sun::star::lang::EventObject iEvent );
+
+ /** is called when a new Undo context has been entered.
+
+ <p>UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and
+ UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the
+ one just entered.</p>
+
+ @see XUndoManager::enterUndoContext
+ */
+ void enteredContext( [in] UndoManagerEvent iEvent );
+
+ /** is called when a new hidden Undo context has been entered.
+
+ <p>UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and
+ UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the
+ one just entered.</p>
+
+ @see XUndoManager::enterUndoContext
+ */
+ void enteredHiddenContext( [in] UndoManagerEvent iEvent );
+
+ /** is called when an Undo context has been left.
+
+ <p>UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and
+ UndoManagerEvent::UndoContextDepth the number of open Undo contexts, excluding the
+ one just left.</p>
+
+ @see XUndoManager::leaveUndoContext
+ @see leftHiddenUndocontext
+ @see cancelledContext
+ */
+ void leftContext( [in] UndoManagerEvent iEvent );
+
+ /** is called when a hidden Undo context has been left.
+
+ <p>UndoManagerEvent::UndoActionTitle is empty, as hidden Undo contexts don't have
+ a title.</p>
+
+ @see XUndoManager::leaveHiddenUndoContext
+ @see leftContext
+ @see cancelledContext
+ */
+ void leftHiddenContext( [in] UndoManagerEvent iEvent );
+
+ /** is called when an Undo context has been left, but no actions have been added within this context.
+
+ <p>In such a case, the context which has just been left will not contribute to the undo stack, but instead
+ be silently removed. Consequently, the UndoManagerEvent::UndoActionTitle is empty.</p>
+
+ @see XUndoManager::leaveUndoContext
+ @see leftContext
+ @see leftHiddenContext
+ */
+ void cancelledContext( [in] UndoManagerEvent iEvent );
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XUndoManagerSupplier.idl b/offapi/com/sun/star/document/XUndoManagerSupplier.idl
new file mode 100644
index 000000000..b3affa1ec
--- /dev/null
+++ b/offapi/com/sun/star/document/XUndoManagerSupplier.idl
@@ -0,0 +1,48 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XUndoManagerSupplier_idl__
+#define __com_sun_star_document_XUndoManagerSupplier_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module document {
+
+interface XUndoManager;
+
+
+/** provides access to an XUndoManager.
+
+ @since OOo 3.4
+ */
+interface XUndoManagerSupplier
+{
+ /** returns the Undo manager associated with the component.
+ */
+ XUndoManager getUndoManager();
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XVbaMethodParameter.idl b/offapi/com/sun/star/document/XVbaMethodParameter.idl
new file mode 100644
index 000000000..3cd8467c6
--- /dev/null
+++ b/offapi/com/sun/star/document/XVbaMethodParameter.idl
@@ -0,0 +1,50 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_document_XVbaMethodParameter_idl__
+#define __com_sun_star_document_XVbaMethodParameter_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module document {
+
+//gives access to VBA method input/output parameters
+//some OO objects need to implement this interface to support the passing of input/output parameters
+//for certain VBA events
+
+interface XVbaMethodParameter : com::sun::star::uno::XInterface
+{
+
+ /** sets the value of the parameter with the specified name.
+ */
+ void setVbaMethodParameter( [in] string PropertyName,
+ [in] any Value );
+
+
+ /** returns the value of the parameter with the specified name.
+ */
+ any getVbaMethodParameter( [in] string PropertyName );
+};
+
+
+}; }; }; };
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XViewDataSupplier.idl b/offapi/com/sun/star/document/XViewDataSupplier.idl
new file mode 100644
index 000000000..29f92883d
--- /dev/null
+++ b/offapi/com/sun/star/document/XViewDataSupplier.idl
@@ -0,0 +1,63 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XViewDataSupplier_idl__
+#define __com_sun_star_document_XViewDataSupplier_idl__
+
+#include <com/sun/star/container/XIndexAccess.idl>
+
+
+module com { module sun { module star { module document {
+
+/** gives access to some properties describing all open views to a document
+
+ <p>
+ Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >.
+ Through this interface the state of all open views can be retrieved and restored
+ later. These states can also be made persistent so that a document loader can create
+ all views of the correct types and restore their state to the state when the document was
+ saved.
+ </p>
+ */
+published interface XViewDataSupplier: com::sun::star::uno::XInterface
+{
+ /** retrieve information about currently opened view to restore it later
+
+ @returns
+ a com::sun::star::container::XIndexAccess,
+ that gives access to a list of com::sun::star::beans::PropertyValue
+ for every open view. May `NULL` if no view is currently available.
+ */
+ ::com::sun::star::container::XIndexAccess getViewData();
+
+ /** restore all views which will be represented by given data argument
+
+ @param Data
+ a list of com::sun::star::beans::PropertyValues
+ with information about last opened views to restore it
+ `NULL` isn't allowed here.
+ */
+ void setViewData( [in] com::sun::star::container::XIndexAccess Data );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/document/XXMLBasicExporter.idl b/offapi/com/sun/star/document/XXMLBasicExporter.idl
new file mode 100644
index 000000000..35ee98cbd
--- /dev/null
+++ b/offapi/com/sun/star/document/XXMLBasicExporter.idl
@@ -0,0 +1,52 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_document_XXMLBasicExporter_idl__
+#define __com_sun_star_document_XXMLBasicExporter_idl__
+
+#include <com/sun/star/document/XExporter.idl>
+#include <com/sun/star/document/XFilter.idl>
+
+
+
+module com { module sun { module star { module document {
+
+
+/** Provides unified interface for XMLOasisBasicExporter and XMLBasicExporter services.
+ @since LibreOffice 4.1
+ */
+published interface XXMLBasicExporter
+{
+
+ /** sets the source document for this filter.
+ */
+ interface com::sun::star::document::XExporter;
+
+
+ /** filters the document.
+ */
+ interface com::sun::star::document::XFilter;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */