summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl67
1 files changed, 67 insertions, 0 deletions
diff --git a/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl
new file mode 100644
index 000000000..1c09688d2
--- /dev/null
+++ b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.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_script_DocumentScriptLibraryContainer_idl__
+#define __com_sun_star_script_DocumentScriptLibraryContainer_idl__
+
+#include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
+#include <com/sun/star/document/XStorageBasedDocument.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+
+
+module com { module sun { module star { module script {
+
+
+/** defines a container of StarBasic script libraries, which is to be made
+ persistent in a sub storage of a document storage.
+
+ @since OOo 2.3
+ */
+service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer
+{
+ /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document
+
+ <p>The current storage of the document will be set as initial root storage
+ (see XPersistentLibraryContainer::RootStorage) of the container.</p>
+
+ <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within
+ the implementation of the document to which the container should belong.</p>
+
+ @param Document
+ The document to which the container should belong to. Must not be
+ `NULL`.
+
+ @throws ::com::sun::star::lang::IllegalArgumentException
+ if <code>Document</code> does not denote a valid
+ com::sun::star::document::OfficeDocument.
+ */
+ create( [in] ::com::sun::star::document::XStorageBasedDocument Document )
+ raises( ::com::sun::star::lang::IllegalArgumentException );
+
+ createWithURL( [in] string URL );
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */